在Web开发中，前后端分离开发已经深入人心，这样的开发模式对于开发优雅美观的web应用非常有益。我在网上查阅了一些资料，学习了在Spring Boot开发中使用有利于前端小伙伴合作开发的统一格式返回值，在这里总结一下：

在这里，我用到了一个辅助框架Lombok，它可以通过少量简洁的注解来实现Class的Getter/Setter方法需求，以及无参/有参构造器及Builder实现，而不需要实际编写它们。

你只要添加如下依赖就能轻松使用上述功能了：

<!-- Lombok -->
<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.8</version>
</dependency>

具体使用方法可以查阅相关资料。

首先，我编写了一个枚举ResultCode：

public enum ResultCode {SUCCESS(0,"成功"),SYSTEM_ERROR(500,"系统错误"),PARAM_IS_INVALID(1000,"参数错误"),USER_IS_EXISTED(1001,"用户已存在");private Integer status;private String message;ResultCode(Integer status,String message){this.status=status;this.message=message;}public Integer status(){return this.status;}public String message(){return this.message;}
}

这个枚举类很简单，有两个属性status（状态）和message（消息），在内部我定义了几种枚举实例，这些实例代表了服务器的几种状态及其相应的描述消息。为上层Result封装提供了固定标识。

先来说说没有异常的普通返回值的封装：

首先，我编写了一个Result类，如下：

@Data
public class Result<T> {private Integer status;private String desc;@Setterprivate T data;public static Result succ(){Result result=new Result();result.setResultCode(ResultCode.SUCCESS);return result;}public static Result succ(Object data){Result result=new Result();result.setResultCode(ResultCode.SUCCESS);result.setData(data);return result;}public static Result fail(Integer status,String desc){Result result=new Result();result.setStatus(status);result.setDesc(desc);return result;}public static Result fail(ResultCode resultCode){Result result=new Result();result.setResultCode(resultCode);return result;}private void setResultCode(ResultCode resultCode){this.status=resultCode.status();this.desc=resultCode.message();}
}

Result是对ResultCode的进一步封装，它添加了一个泛型属性data，data用来存储未经封装的原始数据，其中包含两个succ方法，表示成功处理请求并返回的情况，succ()返回null，说明没有数据返回但处理成功，succ(Object)将返回值封装成Result统一格式返回给前端。

在做好Result封装后，需要使用SpringAOP相关类来处理，在这里需要用到ResponseBodyAdvice接口，这是Spring的一个针对response返回值进行增强处理的AOP接口。

我对其进行了接口实现：

@ControllerAdvice(basePackages = "com.welfarezhu.boot.demo")
public class ResponseHandler implements ResponseBodyAdvice {//当返回值为true时功能才生效@Overridepublic boolean supports(MethodParameter methodParameter, Class aClass) {return true;}@Overridepublic Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {if (o instanceof String){return JsonUtil.toJsonString(Result.succ(o));}return Result.succ(o);}
}

对于beforeBodyWrite方法，在这里我们只需要关注第一个参数Object o，其就是源自Controller处理返回的值。可以看到其中的IF语句，由于java的String类型需要JSON工具转化才能出现我们想要的结果，所以这个IF语句是必要的。

编写一个Controller测试一下：

这里我们用到了一个User实体类：

@Data
@Table
public class User {@Id@KeySql(useGeneratedKeys = true)private int id;private  String name;private String address;private int age;private String phoneNum;@Overridepublic String toString() {return "User{" +"id=" + id +", name='" + name + '\'' +", address='" + address + '\'' +", age=" + age +", phoneNum='" + phoneNum + '\'' +'}';}
}

编写Controller：

@RestController
@Slf4j
public class HelloController {@GetMapping("/hello")public String hello(){int count=2080;return "Hello , "+count;}@GetMapping("/userInfo")public User outputUser(){User user=new User();user.setId(1001);user.setName("Bob");user.setAddress("The U.S.A");user.setAge(24);user.setPhoneNum("13200001111");return user;}
}

启动Spring Boot ，访问/hello，结果如下

{"status":0,"desc":"成功","data":"Hello , 2080"}

访问/userInfo，结果如下：

{"status": 0,"desc": "成功","data": {"id": 1001,"name": "朱剑飞","address": "河南省灵宝市","age": 24,"phoneNum": "13200001111"}
}

这样的结果封装对前端开发人员就很友好了。