依照下方提示依次创建entity、mapper、service、service实现类、controller，创建后的目录结构应当如下图所示：
入门开发指南-后端开发-功能开发-01.png

创建entity

  1. package com.ustcinfo.eip.todo.entity;
  3. import com.baomidou.mybatisplus.annotation.TableId;
  4. import com.baomidou.mybatisplus.annotation.TableName;
  5. import com.ustcinfo.ishare.eip.admin.common.validator.group.AddGroup;
  6. import com.ustcinfo.ishare.eip.admin.common.validator.group.UpdateGroup;
  7. import io.swagger.annotations.ApiModel;
  8. import io.swagger.annotations.ApiModelProperty;
  9. import lombok.Data;
  11. import javax.validation.constraints.NotBlank;
  13. /**
  14. * 待办事项实体
  15. *
  16. * @author liuchengbiao
  17. * @date 2019/4/25 下午3:25
  18. */
  19. @Data
  20. @ApiModel
  21. @TableName("todo")
  22. public class TodoEntity {
  24.     @TableId
  25.     @ApiModelProperty(notes = "待办事项ID")
  26.     private Long id;
  28.     @ApiModelProperty(notes = "待办事项名称")
  29.     @NotBlank(message = "待办事项不能为空", groups = {AddGroup.class, UpdateGroup.class})
  30.     private String name;
  32.     @ApiModelProperty(notes = "待办事项状态")
  33.     private Integer status;
  34. }
  • 这里使用了 lombok 的 @Data注解，会自动生成xxxGetter、xxxSetter、toString等方法
  • 这里使用了swagger注解 @ApiModel 以及 @ApiModelProperty 用于生成接口文档时参数的说明
  • @TableName注解规定了该实体对应的表名
  • 如果指定主键，只需要在主键属性上添加 @TableId 注解即可

该实体在生成的接口文档中的描述
63.png

创建mapper

  1. package com.ustcinfo.eip.todo.mapper;
  3. import com.ustcinfo.eip.todo.entity.TodoEntity;
  4. import com.ustcinfo.ishare.eip.admin.starter.mybatis.mapper.AdminBaseMapper;
  5. import org.apache.ibatis.annotations.Mapper;
  7. /**
  8. * @author liuchengbiao
  9. * @date 2019/4/25 下午3:29
  10. */
  11. @Mapper
  12. public interface TodoMapper extends AdminBaseMapper<TodoEntity> {
  13. }

只需要集成 AdminBaseMapper 并指明对应的泛型实体类即可，其他代码都不需要编写，就这么简单

创建service

  1. package com.ustcinfo.eip.todo.service;
  3. import com.baomidou.mybatisplus.extension.service.IService;
  4. import com.ustcinfo.eip.todo.entity.TodoEntity;
  5. import com.ustcinfo.ishare.eip.admin.common.utils.MapUtils;
  6. import com.ustcinfo.ishare.eip.admin.starter.mybatis.page.PageUtils;
  8. /**
  9. * @author liuchengbiao
  10. * @date 2019/4/25 下午3:32
  11. */
  12. public interface TodoService extends IService<TodoEntity> {
  14.     /**
  15.     * 分页查询
  16.     *
  17.     * @param params
  18.     * @return
  19.     */
  20.     PageUtils<TodoEntity> queryPage(MapUtils params);
  21. }

只需要继承 IService 接口并指明对应的泛型实体即可，如果有其他特殊的需求需要添加方法的话，还可以在这里定义抽象方法（这里以分页为例，其他CURD都可以不用写的）。

创建service实现类

  1. package com.ustcinfo.eip.todo.service.impl;
  3. import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  4. import com.baomidou.mybatisplus.core.metadata.IPage;
  5. import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
  6. import com.ustcinfo.eip.todo.entity.TodoEntity;
  7. import com.ustcinfo.eip.todo.mapper.TodoMapper;
  8. import com.ustcinfo.eip.todo.service.TodoService;
  9. import com.ustcinfo.ishare.eip.admin.common.utils.MapUtils;
  10. import com.ustcinfo.ishare.eip.admin.starter.mybatis.page.PageUtils;
  11. import com.ustcinfo.ishare.eip.admin.starter.mybatis.page.Query;
  12. import com.ustcinfo.ishare.eip.admin.starter.mybatis.utils.QueryWrapperUtils;
  13. import org.springframework.stereotype.Service;
  15. /**
  16. * @author liuchengbiao
  17. * @date 2019/4/25 下午3:33
  18. */
  19. @Service("todoService")
  20. public class TodoServiceImpl extends ServiceImpl<TodoMapper, TodoEntity> implements TodoService {
  21.     @Override
  22.     public PageUtils<TodoEntity> queryPage(MapUtils params) {
  23.         String searchKey = params.getString("searchKey");
  24.         // 模糊查询
  25.         QueryWrapper<TodoEntity> queryWrapper = QueryWrapperUtils.wrapperLike(new QueryWrapper<TodoEntity>(), searchKey, "name");
  26.         // 安装类型查询
  27.         Integer status = params.getInteger("status");
  28.         queryWrapper.eq(status != null, "status", status);
  29.         // 排序
  30.         queryWrapper.orderByDesc("id");
  31.         IPage<TodoEntity> page = this.page(new Query<TodoEntity>(params).getPage(), queryWrapper);
  32.         return new PageUtils(page);
  33.     }
  34. }
  • 实现接口 TodoService 并实现其抽象方法即可
  • 主要类上的 @Service注解不可少
  • 需要指明对应的实体以及实体对应的mapper

创建controller

  1. package com.ustcinfo.eip.todo.controller;
  3. import com.google.common.collect.Lists;
  4. import com.ustcinfo.eip.todo.entity.TodoEntity;
  5. import com.ustcinfo.eip.todo.service.TodoService;
  6. import com.ustcinfo.ishare.eip.admin.common.utils.MapUtils;
  7. import com.ustcinfo.ishare.eip.admin.controller.AbstractController;
  8. import com.ustcinfo.ishare.eip.admin.service.sys.annotation.SysLog;
  9. import com.ustcinfo.ishare.eip.admin.common.form.JsonResult;
  10. import com.ustcinfo.ishare.eip.admin.starter.mybatis.page.PageUtils;
  11. import com.ustcinfo.ishare.eip.admin.common.validator.ValidatorUtils;
  12. import io.swagger.annotations.*;
  13. import org.springframework.beans.factory.annotation.Autowired;
  14. import org.springframework.http.MediaType;
  15. import org.springframework.web.bind.annotation.*;
  16. import springfox.documentation.annotations.ApiIgnore;
  18. import java.util.Map;
  20. /**
  21. * 待办事项的接口
  22. *
  23. * @author liuchengbiao
  24. * @date 2019/4/25 下午3:35
  25. */
  26. @RestController
  27. @RequestMapping("/todo")
  28. @Api(tags = "待办事项")
  29. public class TodoController extends AbstractController {
  31.     @Autowired
  32.     private TodoService todoService;
  35.     @GetMapping("/list")
  36.     @ApiOperation(value = "列表", notes = "分页待办功能列表", produces = MediaType.APPLICATION_JSON_VALUE)
  37.     @ApiImplicitParams({
  38.     @ApiImplicitParam(name = "page", value = "页码", paramType = "query", required = true, dataType = "int"),
  39.     @ApiImplicitParam(name = "limit", value = "每页条数", paramType = "query", required = true, dataType = "int"),
  40.     @ApiImplicitParam(name = "sidx", value = "排序字段", paramType = "query", dataType = "string"),
  41.     @ApiImplicitParam(name = "order", value = "排序方式，如：asc、desc", paramType = "query", dataType = "string"),
  42.     @ApiImplicitParam(name = "status", value = "状态", paramType = "query", dataType = "int"),
  43.     @ApiImplicitParam(name = "searchKey", value = "查询条件", paramType = "query", dataType = "string")
  44.     })
  45.     public JsonResult<PageUtils<TodoEntity>> list(@ApiIgnore @RequestParam Map<String, Object> params) {
  46.         PageUtils<TodoEntity> page = todoService.queryPage(MapUtils.getInstance(params));
  47.         return JsonResult.ok().put(page);
  48.     }
  51.     @SysLog("添加待办事项")
  52.     @PostMapping("/save")
  53.     @ApiOperation(value = "添加", notes = "添加待办事项", produces = MediaType.APPLICATION_JSON_VALUE)
  54.     public JsonResult<Void> save(@ApiParam(name = "添加的待办事项对象", value = "传入json格式", required = true) @RequestBody TodoEntity todo) {
  55.         ValidatorUtils.validateEntity(todo);
  56.         todoService.save(todo);
  57.         return JsonResult.ok();
  58.     }
  61.     @SysLog("修改待办事项")
  62.     @PostMapping("/update")
  63.     @ApiOperation(value = "修改", notes = "修改待办事项", produces = MediaType.APPLICATION_JSON_VALUE)
  64.     public JsonResult<Void> update(@ApiParam(name = "修改的待办事项对象", value = "传入json格式", required = true) @RequestBody TodoEntity todo) {
  65.         ValidatorUtils.validateEntity(todo);
  66.         todoService.updateById(todo);
  67.         return JsonResult.ok();
  68.     }
  70.     @GetMapping("/info/{id}")
  71.     @ApiOperation(value = "详情", notes = "获取指定ID的详细信息", produces = MediaType.APPLICATION_JSON_VALUE)
  72.     public JsonResult<TodoEntity> info(@PathVariable("id") Long id) {
  73.         TodoEntity todo = todoService.getById(id);
  74.         return JsonResult.ok().put(todo);
  75.     }
  78.     @SysLog("删除待办事项")
  79.     @PostMapping("/delete")
  80.     @ApiOperation(value = "删除", notes = "删除待办事项", produces = MediaType.APPLICATION_JSON_VALUE)
  81.     public JsonResult<Void> delete(@RequestBody Long[] ids) {
  82.         todoService.removeByIds(Lists.newArrayList(ids));
  83.         return JsonResult.ok();
  84.     }
  86.     @SysLog("改变状态")
  87.     @PostMapping("/toggle/{id}")
  88.     @ApiOperation(value = "改变状态", notes = "改变状态", produces = MediaType.APPLICATION_JSON_VALUE)
  89.     public JsonResult<Void> toggle(@PathVariable(name = "id") Long id) {
  90.         TodoEntity todo = todoService.getById(id);
  91.         if (todo != null) {
  92.         todo.setStatus(todo.getStatus() * -1);
  93.         todoService.updateById(todo);
  94.         }
  95.         return JsonResult.ok();
  96.     }
  99. }
  • 在类上添加 @RestController 相当于 @Controller 和 @ResponseBody 注解合体
  • 在类上使用swagger 的@Api注解用来标识生成的文档中的左侧接口描述
  • 在方法上使用@SysLog注解用来记录操作的日志，括号中填写操作的名称
  • 在方法上使用@PostMapping 表示仅接受post请求，括号中是请求的部分URI
  • 在方法上使用 swagger 的 @ApiOperation 注解用来表示该方法的作用以及传参类型
  • 在方法上使用 swagger 的 @ApiImplicitParams 注解用来标识该方法的入参信息，包括入参名称、类型、必填项、默认值等
  • 基础框架controller中方法的返回值是 JsonResult ，他接受一个返回数据的泛型，前端会收到他的json数据