Spring Boot 2.x :优雅的统一返回值及使用

703 阅读1分钟

一、统一返回值代码

package com.sise.wangzhan.commonutils;

import lombok.Data;

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

/**
 *  Copyright: Copyright (c) 2020 Asiainfo
 *  
 *  @ClassName: com.sise.wangzhan.commonutils.R
 *  @Description: 统一返回结果的类
 * <p>
 *  @version: v1.0.0
 *  @author:   wangzhan
 *  @date: 2020/12/30 10:17 
 * <p>
 *  Modification History:
 *  Date       Author    Version    Description
 * ----------------------------------------------------------
 *  2020/12/30    acer     v1.0.0      修改原因
 */
@Data
public class R {

    // 是否成功
    private Boolean success;

    // 状态码
    private Integer code;

    // 描述信息
    private String description;

    // 返回数据
    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);
        r.setDescription("成功");
        return r;
    }

    // 返回失败
    public static R error(){
        R r = new R();
        r.setSuccess(false);
        r.setCode(ResultCode.ERROR);
        r.setDescription("失败");
        return r;
    }

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

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

    public R description(String description){
        this.setDescription(description);
        return this;
    }

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

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

}

二、在controller使用

类似这种的返回方式

// 获取token
    @PostMapping(value = "/login")
    public R login(@RequestBody Member member){
        try {
            // 根据昵称和密码查询该用户是否存在
            Member loginMember = memberService.getMemberByNicknameAndPassword(member);

            if (loginMember == null){
                return R.error().description("登录失败!!!");
            }else if (loginMember != null){

                // 获取token
                String token = JwtUtils.getJwtToken(loginMember.getId(), loginMember.getNickname());

                return R.ok().data("token", token);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

返回前台接收(我用的是vue.js)

response.data.data.token  (这里的token是后端传的第一个参数的值)