- 说白了就是对我们传给前端的东西一个规范化,就像下面这样,data里面所有的东西都是我们需要传递的数据,前端如果需要数据就得从这里面去拿。code是一个状态码,这个可以根据约定自行去约定,最后一位数是1就代表成功,是0就代表失败,这里的定义空间很大;最后就是提示信息,如果数据传输成功了,那就不需要有什么传递的信息,直接一个空的字符串就可以,如果失败或者查询失败就提示用户,”查询失败请重试。“
- msg这里需要分辨一下,哪些需要传入msg,一般来说,对于增加一条,删除一条,修改一条,这里都是返回的true或者是false,这里直接当作消息传输过去就可以。对于查询一条或者全部查询,就需要进行判断,如果查询的内容为空,那就是得提示用户。
实现过程。
这个的实现其实也并不复杂,这里只需管住controller包,既然最后需要返回给前端一个json里面有三个属性,那我们就定义返回的这个东西叫做result,在controller中定义这类。
- Result类
package com.itheima.controller;
public class Result {
//描述统一格式中的数据
private Object data;
//描述统一格式中的编码,用于区分操作,可以简化配置0或1表示成功失败
private Integer code;
//描述统一格式中的消息,可选属性
private String msg;
public Result() {
}
//先是状态码 这是开发习惯
public Result(Integer code,Object data) {
this.data = data;
this.code = code;
}
public Result(Integer code, Object data, String msg) {
this.data = data;
this.code = code;
this.msg = msg;
}
public Object getData() {
return data;
}
public void setData(Object data) {
this.data = data;
}
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
}
- Code状态码
状态码这全部都是常量,可以自行定义。这里对我来说还确实是第一次见到这样的定义,但是也不算难,就跟定义普通的变量一样。学习到了。
package com.itheima.controller;
//状态码
public class Code {
//常量
public static final Integer SAVE_OK = 20011;
public static final Integer DELETE_OK = 20021;
public static final Integer UPDATE_OK = 20031;
public static final Integer GET_OK = 20041;
public static final Integer SAVE_ERR = 20010;
public static final Integer DELETE_ERR = 20020;
public static final Integer UPDATE_ERR = 20030;
public static final Integer GET_ERR = 20040;
}
BookController
这里就有了相关的变动了,一个是返回值,需要返回result,只有这样才会给前端。result里面的东西对于增删改来说比较简单,因为查询的内容就是true和false,但是对于查询单个或者查询所有就不一样了,这里就多了一个判断的操作。这里使用到了三目运算符,也算是学习的一个地方。
package com.itheima.controller;
import com.itheima.domain.Book;
import com.itheima.service.BookService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
@RequestMapping("/books")
public class BookController {
@Autowired
private BookService bookService;
@PostMapping
public Result save(@RequestBody Book book) {
boolean flag = bookService.save(book);
//三目运算
return new Result(flag ? Code.SAVE_OK:Code.SAVE_ERR, flag);
}
@PutMapping
public Result update(@RequestBody Book book) {
boolean flag = bookService.update(book);
return new Result(flag ? Code.UPDATE_OK:Code.UPDATE_ERR, flag);
}
@DeleteMapping("/{id}")
public Result delete(@PathVariable Integer id) {
boolean flag = bookService.delete(id);
return new Result(flag ? Code.DELETE_OK:Code.DELETE_ERR, flag);
}
@GetMapping("/{id}")
public Result getById(@PathVariable Integer id) {
Book book = bookService.getById(id);
Integer code = book != null ? Code.GET_OK : Code.GET_ERR;
String msg = book != null ? "" : "数据查询失败,请重试!";
return new Result(code, book, msg);
}
@GetMapping
public Result getAll() {
List<Book> books = bookService.getAll();
Integer code = books != null ? Code.GET_OK : Code.GET_ERR;
String msg = books != null ? "" : "数据查询失败,请重试!";
return new Result(code, books, msg);
}
}