1 开发环境介绍
1.1 开发工具
idea + maven
1.2 导入依赖 - lombok
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
<scope>provided</scope>
</dependency>
2 工具类代码示例 - - - Result
import lombok.Getter;
import lombok.Setter;
@Getter
@Setter
public class Result<T> {
private static Integer CODE_SUCCESS = 1;
private static Integer CODE_ERROR = 0;
private static String DEFAULT_SUCCESS_MSG = "success";
private static String DEFAULT_ERROR_MSG = "error";
private Integer code;
private T data;
private String msg;
private Result() {
}
private Result(Integer code, T b, String msg) {
this.code = code;
this.data = b;
this.msg = msg;
}
public static <T> Result success() {
return new Result(CODE_SUCCESS, true, DEFAULT_SUCCESS_MSG);
}
public static <T> Result success(T data) {
return new Result<>(CODE_SUCCESS, data, DEFAULT_SUCCESS_MSG);
}
public static <T> Result success(String msg) {
return new Result<>(CODE_SUCCESS, true, msg);
}
public static <T> Result error() {
return new Result(CODE_ERROR, false, DEFAULT_ERROR_MSG);
}
public static <T> Result error(T data) {
return new Result(CODE_ERROR, data, DEFAULT_ERROR_MSG);
}
public static <T> Result error(String msg) {
return new Result(CODE_ERROR, false, msg);
}
}
3 工具类测试
3.1 测试工具
postman
3.2 测试代码
使用idea创建一个springboot项目,只选择web即可
@RestController
@RequestMapping("/test")
public class test {
@GetMapping("/success")
public Result testUtilResultSuccessDef(){
return Result.success();
}
@GetMapping("/error")
public Result testUtilResultErrorDef(){
return Result.error();
}
}
3.3 测试接口
不做配置的项目,默认启动的端口是8080,因此可采用下述两个接口来测试
- 成功的测试接口示例:127.0.0.1:8080/test/success
- 失败的测试接口示例:127.0.0.1:8080/test/error
4 代码解析
代码/属性 | 解释 |
---|
code | 响应码 | data | 响应数据 | msg | 响应类型 | CODE_SUCCESS | 默认的请求成功响应码 | CODE_ERROR | 默认的请求失败响应码 | DEFAULT_SUCCESS_MSG | 默认的请求成功响应类型 | DEFAULT_ERROR_MSG | 默认的请求失败响应类型 | public static Result success() | 默认的请求成功,返回 状态码:CODE_SUCCESS 响应数据:true 响应信息:DEFAULT_SUCCESS_MSG | public static Result success(T data) | 请求成功,可设置响应数据 | public static Result success(String msg) | 请求成功,可设置响应类型 | public static Result error() | 默认的请求失败,返回 状态码:CODE_ERROR 响应数据:false 响应信息:DEFAULT_ERROR_MSG | public static Result error(T data) | 请求失败,可设置响应数据 | public static Result error(String msg) | 请求失败,可设置响应类型 |
|