统一返回结果

最新推荐文章于 2024-01-15 02:29:15 发布

原创最新推荐文章于 2024-01-15 02:29:15 发布 · 175 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

收录于

java

本文介绍了如何在Spring Boot项目中创建一个统一的响应结果类R，包括成功和错误的静态方法，并展示了在EduTeacherController中如何使用。同时，文章提到了 Swagger 的使用，用于提供API的中文注释和接口文档。此外，还配置了全局的JSON时间格式为'yyyy-MM-dd HH:mm:ss'，并展示了返回的成功示例。

统一返回结果

在common_utils,创建包com.atguigu.commonutils，创建接口 ResultCode.java

public interface ResultCode {

    public static Integer SUCCESS = 20000;
    public static Integer ERROR = 20001;

}

com.atguigu.commonutils下创建统一返回结果类 R.java

@Data
public class R {

    //创建四个属性，Boolean、Integer、String、Map
    @ApiModelProperty(value = "是否成功")
    private Boolean success;

    @ApiModelProperty(value = "返回码")
    private Integer code;

    @ApiModelProperty(value = "返回消息")
    private String message;

    @ApiModelProperty(value = "返回数据")
    private Map<String, Object> data = new HashMap<String, Object>();

    //把构造方法私有化
    private R(){}

    //成功的静态方法
    public static R ok(){
        R r = new R();
        r.setSuccess(true);
        r.setCode(ResultCode.SUCCESS);     //调用那个20000
        r.setMessage("成功");
        return r;
    }

    //失败的静态方法
    public static R error(){
        R r = new R();
        r.setSuccess(false);
        r.setCode(ResultCode.ERROR);
        r.setMessage("失败");
        return r;
    }

    public R success(Boolean success){
        this.setSuccess(success);
        return this;
    }

    public R message(String message){
        this.setMessage(message);
        return this;

    }

    public R code(Integer code){
        this.setCode(code);
        return this;
    }

    public R data(String key, Object value){
        this.data.put(key, value);
        return this;

    }

    public R data(Map<String, Object> map){
        this.setData(map);
        return this;

    }
}

在service_edu中，使用这个，需要在service的pom添加：

        <dependency>
            <groupId>com.zpc</groupId>
            <artifactId>common_utils</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

把service_edu中返回方法都改成R，再更改return

@Api(description = "讲师管理")   //给swagger添加一些中文注释
@RestController      //交给spring，返回json数据
@RequestMapping("/eduservice/edu-teacher")  //访问的注解

public class EduTeacherController {

    //把service注入
    @Autowired
    private EduTeacherService teacherService;

    //查询：http://localhost:8001/eduservice/edu-teacher/findAll

    //查询讲师列表所用数据
    //rest风格
    @ApiOperation(value = "所有讲师列表")   //给swagger添加一些中文注释
    @GetMapping("findAll")
    public R findAllTeacher(){
        //调用service的方法实现查询所有的操作
        List<EduTeacher> list=teacherService.list(null);
        return R.ok().data("items",list);    //将list弄到items中，items是一个Map
    }


    @ApiOperation(value = "逻辑删除讲师")   //给swagger添加一些中文注释
    @DeleteMapping("{id}")   //id值，需要通过路径传递，例：localhost:8001/edu/delete/1(id=1)
    public R removeById(@ApiParam(name = "id",value = "讲师id",required = true) @PathVariable String id){
        return R.ok();
    }

}

注：返回的结果：

{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "items": [
      {
        "id": "1",
        "name": "张三",
        "intro": "近年主持国家自然科学基金（6项）、江苏省重大科技成果转化项目（5项）、江苏省产学研前瞻性联合研究项目（3项）、省工业科技支撑、省高技术、省自然科学基金等省部级及其企业的主要科研项目40多个，多个项目在企业成功转化，产生了较好的经济、社会和环境效益。积极开展产学研科技合作，并与省内16家企业建立了江苏省研究生工作站，其中6家为江苏省优秀研究生工作站",
        "career": "高级",
        "level": 1,
        "avatar": "https://guli-file-190513.oss-cn-beijing.aliyuncs.com/avatar/default.jpg",
        "sort": 0,
        "isDeleted": 0,
        "gmtCreate": "2019-10-30 14:18:46",
        "gmtModified": "2019-11-12 13:36:36"
      },

统一时间格式

#返回json的全局时间格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8

标签

#java