之前封装了一个响应实体类,但是返回值没有使用泛型,而是直接使用Object对象,这样使用起来还是不太好,返回值不能在controller中一眼看到,而是要看具体代码,今天再封装一个返回值为泛型的响应实体类
1、定义响应状态码枚举类,枚举类用来定义项目中要使用到的状态码
public enum ResponseEnum {
// 可以根据自己的实际需要增加状态码
SUCCESS("0", "ok"),
SERVER_INNER_ERR("500","系统繁忙"),
PARAM_LACK("100" , "非法参数"),
OPERATION_FAILED("101" ,"操作失败"),
;
private String code;
private String msg;
ResponseEnum(String code, String msg) {
this.code = code;
this.msg = msg;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
}
2、定义响应实体类,在这里引用ResponseEnum枚举,定义了响应消息和响应数据对象若干方法(也可以将上面的ResponseEnum枚举直接定义在该类内部,看个人喜好)
import com.fasterxml.jackson.annotation.JsonInclude; @JsonInclude(JsonInclude.Include.NON_NULL) public class Response{ private String code; private String msg; private T data; public static Response success() { return rspMsg(ResponseEnum.SUCCESS); } public static Response fail() { return rspMsg(ResponseEnum.SERVER_INNER_ERR); } public static Response rspMsg(ResponseEnum responseEnum) { Response message = new Response (); message.setCode(responseEnum.getCode()); message.setMsg(responseEnum.getMsg()); return message; } public static Response rspMsg(String code , String msg) { Response message = new Response (); message.setCode(code); message.setMsg(msg); return message; } public static Response rspData(T data) { Response responseData = new Response (); responseData.setCode(ResponseEnum.SUCCESS.getCode()); responseData.setData(data); return responseData; } public static Response rspData(String code , T data) { Response responseData = new Response (); responseData.setCode(code); responseData.setData(data); return responseData; } public String getCode() { return code; } public void setCode(String code) { this.code = code; } public String getMsg() { return msg; } public void setMsg(String msg) { this.msg = msg; } public T getData() { return data; } public void setData(T data) { this.data = data; } }
3、在controller中使用响应实体类,在controller中展示了响应消息和响应数据的例子
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("student")
public class StudentController {
@GetMapping("studentInfo")
public Response studentInfo() {
Student student = new Student();
student.setId(1);
student.setName("张三");
student.setAge(30);
return Response.rspData(student);
}
@GetMapping("success")
public Response success() {
// 逻辑代码
return Response.success();
}
@GetMapping("fail")
public Response fail() {
// 逻辑代码
return Response.fail();
}
@GetMapping("msg")
public Response msg() {
// 逻辑代码
// 返回操作失败
return Response.rspMsg(ResponseEnum.OPERATION_FAILED);
}
}
使用postman访问以上接口,响应结果如下图所示



