用 MyBatis-Plus 实现标准 CRUD 接口

zjc 于 2026-08-06 发布

用户、商品这类单表资源很适合抽象成统一 CRUD 形状。这个项目的用户接口是：

GET    /user/{id}
GET    /user/list
GET    /user/page
POST   /user
PUT    /user
DELETE /user/{id}

由于公共模块会自动追加 /api/v1/provider 前缀，Controller 里只写资源路径。

一、查询单个

@GetMapping("/user/{id}")
public ApiResponse<UserDTO> getUser(@PathVariable Long id) {
    return ApiResponse.success(userConverter.entityToDto(userService.getById(id)));
}

https://github.com/springvortex/spring-cloud-alibaba/blob/release/v1.0.0/service-provider/src/main/java/com/zjc/provider/controller/UserController.java

查询不到时返回 success=true、data=null。这种设计表示“请求处理成功，但没有这条资源”。

二、新增

@PostMapping("/user")
public ApiResponse<UserDTO> add(@Valid @RequestBody UserDTO dto) {
    User user = userConverter.dtoToEntity(dto);
    userService.save(user);
    return ApiResponse.success(userConverter.entityToDto(user));
}

https://github.com/springvortex/spring-cloud-alibaba/blob/release/v1.0.0/service-provider/src/main/java/com/zjc/provider/controller/UserController.java

save 后实体会带上生成的主键，再转换成 DTO 返回。

三、更新和删除要看影响行数

boolean updated = userService.updateById(userConverter.dtoToEntity(dto));
return updated
        ? ApiResponse.success()
        : ApiResponse.failure(ApiResponseEnum.NOT_FOUND);

https://github.com/springvortex/spring-cloud-alibaba/blob/release/v1.0.0/service-provider/src/main/java/com/zjc/provider/controller/UserController.java

更新和删除不能只看 HTTP 请求是否到达。updateById 和 removeById 返回 false 时，说明没有命中有效记录，应该返回业务失败。

四、逻辑删除

removeById 实际执行的是逻辑删除。MyBatis-Plus 会根据配置把 is_deleted 置为已删除，后续查询自动过滤。

五、统一约定