SpringBoot（三）统一接口数据返回设计

SpringBoot（三）统一接口数据返回设计

SpringBoot 统一数据返回设计

期望的接口统一返回格式：

{
  "code": 0,
  "message": "ok",
  "data": "result"
}

SpringBoot 统一数据返回类 Result

package com.hqd8080.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result<T> {

    private Integer code;   //状态码（0：成功、1：失败）
    private String message; //错误信息
    private T data;         //操作成功返回的数据

    /**
     * 操作成功统一格式返回，带数据
     * @param data
     * @return
     * @param <E>
     */
    public static <E> Result<E> success(E data) {
        return new Result<>(0, "操作成功！", data);
    }

    /**
     * 操作成功统一格式返回
     * @return
     */
    public static Result success() {
        return new Result(0, "操作成功！",null);
    }

    /**
     * 操作失败，带错误信息
     * @param message
     * @return
     */
    public static Result error(String message) {
        return new Result(1, message, null);
    }
}

控制器中统一返回

package com.hqd8080.controller;

import com.hqd8080.pojo.Result;
import com.hqd8080.pojo.User;
import com.hqd8080.service.impl.UserService;
import com.hqd8080.utils.JwtUtil;
import com.hqd8080.utils.Md5Util;
import com.hqd8080.utils.ThreadLocalUtil;
import jakarta.validation.constraints.Pattern;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import java.util.HashMap;
import java.util.Map;

@Validated
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @PostMapping("/register")
    public Result register(@Pattern(regexp = "^\\S{5,16}$") String username, @Pattern(regexp = "^\\S{5,16}$") String password) {

        User user = userService.findByUsername(username);
        if (user == null) {
            userService.register(username, password);
            return Result.success();
        }else{
            return Result.error("用户名已经存在！");
        }
    }
}