阿里一面：你做过哪些代码优化？来一个人人可以用的极品案例
前言
在尼恩读者50+交流群中，尼恩经常指导小伙伴改简历。 改简历所涉及的一个要点是：
在 XXX 项目中，完成了 XXX 模块的代码优化
另外，在面试的过程中，面试官也常常喜欢针对提问，来考察候选人对代码质量的追求、对设计模式的应用能力：
你做过哪些代码优化？
大家一般的套路，都是通过模板模式、策略模式等，完成 XXXXX 模块的重构，提升代码的可扩展行，可维护性。
如果有类似的扩展场景还好，头疼的是，很多小伙伴确实没有。然后无奈的说，没有做过代码的优化。
尼恩告诉大家，如果你作为一个高手，连代码优化都没有做过，是不可能的。 尼恩本人从2006开始做Java开发，就一直生活在代码优化的路上。
如果这个问题答不好，你就不是高手，不具备拿高薪的条件。
那么，该在哪里找点代码优化的需求呢？
这里尼恩给大家展示一个简单、又可以称之为极品、又是人人用得着的案例：
后端接口返回结果的二次封装优化
此案例，既能展示大家对代码优雅的追求，也能展示大家对spring框架的雄厚内功，如果面试的时候如数家珍，能让面试官爱到 “刮目相看”。
同时，尼恩一并把这个题目以及参考答案，收入咱们的 《尼恩Java面试宝典》V46版本，供后面的小伙伴参考，提升大家的 3高 架构、设计、开发水平。
场景
在移动互联网，分布式、微服务盛行的今天，现在项目绝大部分都采用的微服务框架，前后端分离方式，一般系统的大致整体架构图如下：
Rest API接口
接口交互
前端和后端进行交互，前端按照约定请求URL路径，并传入相关参数，后端服务器接收请求，进行业务处理，返回数据给前端。
针对URL路径的restful风格，以及传入参数的公共请求头的要求（如：app_version,api_version,device等），这里就不介绍了，小伙伴们可以来尼恩的尼恩读者50+交流群中交流
着重介绍一下后端服务器如何实现把数据返回给前端？
返回格式
后端返回给前端我们一般用JSON体方式，定义如下：
{
#返回状态码
code:integer,
#返回信息描述
message:string,
#返回值
data:object
}
CODE状态码
code返回状态码，一般小伙伴们是在开发的时候需要什么，就添加什么。
如接口要返回用户权限异常，我们加一个状态码为101吧，下一次又要加一个数据参数异常，就加一个102的状态码。这样虽然能够照常满足业务，但状态码太凌乱了
我们应该可以参考HTTP请求返回的状态码
：下面是常见的HTTP状态码：
200 - 请求成功
301 - 资源（网页等）被永久转移到其它URL
404 - 请求的资源（网页等）不存在
500 - 内部服务器错误
| 分类 | 区间 | 分类描述 |
|---|---|---|
| 1** | 100~199 | 信息，服务器收到请求，需要请求者继续执行操作 |
| 2** | 200~299 | 成功，操作被成功接收并处理 |
| 3** | 300~399 | 重定向，需要进一步的操作以完成请求 |
| 4** | 400~499 | 客户端错误，请求包含语法错误或无法完成请求 |
| 5** | 500~599 | 服务器错误，服务器在处理请求的过程中发生了错误 |
我们可以参考这样的设计，这样的好处就把错误类型归类到某个区间内，如果区间不够，可以设计成4位数。
#1000～1999 区间表示参数错误
#2000～2999 区间表示用户错误
#3000～3999 区间表示接口异常
这样前端开发人员在得到返回值后，根据状态码就可以知道，大概什么错误，再根据message相关的信息描述，可以快速定位。
Message
这个字段相对理解比较简单，就是发生错误时，如何友好的进行提示。一般的设计是和code状态码一起设计，如
//状态码枚举
public enum ResultCode {
private Integer code;
private String message;
ResultCode(Integer code， String message) {
this.code = code;
this.message = message;
}
}
再在枚举中定义，状态码
返回状态码
public enum ResultCode {
privateInteger code;
private String message;
ResultCode(Integer code，String message) {
this.code = code;
this.message = message;
}
public Integer code(){
return this.code;
}
public String message() {
return this.message;
}
/* 成功状态码 */
SUCCESS(1，"成功"),
/* 参数错误: 1001-1999 */
PARAM IS INVALID(1001,"参数无效"),
PARAM IS BLANK(1002,"参数为空"),
PARAM TYPE BIND ERROR(1003，"参数类型错误"),
PARAM NOT_COMPLETE(1004,"参数缺失"),
/* 用户错误: 2001-2999*/
USER NOT_LOGGED IN(2001,"用户未登录,访问的路径需要验证,请登录"),
USER LOGIN ERROR(2002,"账号不存在或密码错误"),
USER ACCOUNT FORBIDDEN(2003,"账号已被禁用"),
USER NOT_EXIST(2004,"用户不存在"),
USER HAS EXISTED(2005，"用户已存在")
}
状态码和信息就会一一对应，比较好维护。
Data
返回数据体，JSON格式，根据不同的业务又不同的JSON体。
我们要设计一个返回体类Result
@aData
public class Result implements Serializable {
private Integer code;
private String message;
private Object data;
public Result(ResultCode resultCode, Object data) {
this.code = resultCode.code;
this.message = resultCode.message();
this.data = data;
}
}
控制层Controller
我们会在controller层处理业务请求，并返回给前端，以order订单为例
@RestController
@RequestMapping("/orders")
public class OrderController {
@Autowired
private OrderService orderService;
@GetMapping("{id}")
public Result getOrder(@PathVariable("id") Integer id) {
Order order = orderService.getOrderById(id);
Result result = new Result(ResultCode.SUCCESS,order);
return result;
}
}
我们看到在获得order对象之后，我们是用的Result构造方法进行包装赋值，然后进行返回。
小伙伴们有没有发现，构造方法这样的包装是不是很麻烦，我们可以优化一下。
美观优化
我们可以在Result类中，加入静态方法，一看就懂
@Data
public class Result implements Serializable {
//省。。
//返回成功
public static Result success() {
Result result = new Result();
result.setResultCode(ResultCode.SUCCESS);
return result;
}
//返回成功
public static Result success(Object data) {
Result result = new Result();
result.setResultCode(ResultCode.SUCCESS);
result.setData(data);return result;
}
//返回失败
public static Result failure(ResultCode resultCode) {
Result result = new Result();
result.setResultCode(resultCode);
return result;
}
//返回失败
public static Result failure(ResultCode resultCode, Obiect data){
Result result = new ResultO;
result.setResultCode(resultCode);
result.setData(data);
return result;
}
}
那我们来改造一下Controller
@RestController
@RequestMapping("/orders")
public class OrderController [
@Autowired
private OrderService orderService;
GetMapping("{id}")
public Result getOrder(@PathVariable("id") Integer id) {
if(id == null){
return Result.failure(ResultCode.PARAM IS INVALID);
}
Order order = orderService.getOrderById(id);
return Result.success(order);
}
}
代码比较简洁了，也美观了。
尼恩的SpringCloud开发脚手架，是这么做的。 尼恩公司的那些亿级RMP大项目，也是这么做的。
那么，有没有优化的空间呢？ 当然有。
切面式思想优化
上面我们看到在Result类中增加了静态方法，使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题：
1、每个方法的返回都是Result封装对象，没有业务含义
2、在业务代码中，成功的时候我们调用Result.success，异常错误调用Result.failure。是不是很多余
3、上面的代码，判断id是否为null，其实我们可以使用hibernate validate做校验，没有必要在方法体中做判断。
具体怎么解决呢？宏观的思路如下：
可以应用切面式的思想，把Rest外层包装抽取到切面中，而不是放在业务代码中，从而让业务代码回归业务本身，更为逻辑清晰、结构简单。
优化之后的效果是，业务Controller直接返回真实业务对象，最好不要改变之前的业务方式，如下图
@RestController
@RequestMapping("/orders")
public class OrderController {
@Autowired
private OrderService orderService;
@GetMapping("{id}")
public Order getOrder(aPathVariable("id") Integer id) {
Order order = orderService.getOrderById(id);
return roder;
}
}
业务代码我们平时的代码是一样的，非常直观，直接返回order对象，这样是不是很完美。
切面式的思想的实现方案是什么呢？
切面式的实现方案
小伙伴们怎么去实现是不是有点思路，在这个过程中，我们需要做几个事情
1、定义一个注解@ResponseResult，表示这个接口返回的值需要包装一下
2、拦截请求，判断此请求是否需要被@ResponseResult注解
3、核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice，判断是否需要包装返回值，如果需要，就把Controller接口的返回值进行重写。
注解类
定义一个注解类，用来标记方法的返回值是否需要包装
@Retention(RUNTIME)
@Target({ TYPE，METHOD })
@Documented
public @interface ResponseResult {
}
拦截器
拦截请求，是否此请求返回的值需要包装，
其实就是运行的时候，解析@ResponseResult注解
//请求拦截器
@slf4j
@Component
public class ResponseResultInterceptor implements HandlerInterceptor{
//标记名称
public static final String RESPONSE_RESULT_ANN = "RESPONSE-RESULT-ANN";
@Override
public boolean preHandle(HttpServletRequest reguest, HttpServletResponse response, Object handler)throws Exception {
//请求的方法
if(handler instanceof HandlerMethod){
final HandlerMethod handlerMethod = (HandlerMethod)handler;
final Class<?> clazz = handlerMethod.getBeanType();
final Method method = handlerMethod.getMethod();
//判断是否在类对象上面加了注解
if (clazz.isAnnotationPresent(ResponseResult.class)) {
//设置此请求返回体，需要包装，往下传递，在ResponseBodyAdvice接口进行判断
request.setAttribute(RESPONSE_RESULTANN,clazz.getAnnotation(ResponseResult.class));
}else if (method.isAnnotationPresent(ResponseResult,class)) { //方法体上是否有注解
//设置此请求返回体，需要包装，往下传递，在ResponseBodyAdvice接口进行判断
request.setAttribute(RESPONSE_RESULT_ANN,method.getAnnotation(ResponseResult.class));
}
}
return true;
}
}
此代码核心思想，就是获取此请求，根据注解判断是否需要返回值包装，并且在request上设置一个属性标记。
重写返回体
@slf4j
@ControllerAdvice
public class ResponseResultHandler implements ResponseBodyAdvice<Object>{
//标记名称
public static final String RESPONSE_RESULTANN = "RESPONSE-RESULT-ANN";
//是否请求 包含了 包装注解 标记，没有就直接返回，不需要重写返回体
@Override
public boolean supports (MethodParameter returntype, Class<? extends HttpMessagelonverter<?>> convertertype){
ServletRequestAttributes ra = ((ServletRequestAttributes) RequestContextHolder getRequestAttributes());
HttpServletRequest request = sra.getRequest();
//判断请求 是否有包装标记
ResponseResult responseResultAnn = (ResponseResult) request,getAttribute(RESPONSE RESULT_ANN);
return responseResultAnn == null ? false : true;
}
@Override
public Object beforeBodyWrite(0bject body, MethodParameter returnType, MediaType selectedContentTypeClass<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
log.info("进入 返回体 重写格式 处理中。。。。。");
return Result.success(body);
}
}
上面supports 代码就是判断是否需要返回值包装，如果需要（support返回true）就直接进入 beforeBodyWrite包装。
这里我们只处理了正常成功的包装，如果方法体报异常怎么办？
处理异常也比较简单，只要判断body是否为异常类。
@Override
public Object beforeBodywrite(0bject body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
log.info("进入 返回体 重写格式 处理中。。。。");
if (body instanceof ErrorResult) {
log.info("返回值 异常 作包装 处理中。。。");
ErrorResult errorResult = (ErrorResult) body;
return Result.failure(errorResult.getCode(),errorResult, getMessage ),errorResult, getErrors());
}
return Result.success(body);
}
怎么做全局的异常处理，实现方式有两种
第一种：使用@ControllerAdvice和@ExceptionHandler注解 第二种: 使用ErrorController类来实现。
参考ResponseBodyAdvice，对返回结果，进行二次包装就可以了。
篇幅原因，这里就不做介绍了，只要思路理清楚了，自行改造就行。
重新Controller
@RestController
@RequestMapping("/orders")
@ResponseResult
public class OrderController {
@Autowired
private OrderService orderService;
@GetMapping("{id}")
public Order getOrder(aPathVariable("id") Integer id) {
Order order = orderService.getOrderById(id);
return roder;
}
}
在控制器类上或者方法体上加上@ResponseResult注解，这样就ok了，简单吧。
到此，返回结果的代码优化完成，经过代码优化之后，咱们的代码是不是又简洁，又优雅。
那么，这个方案还有没有别的优化空间，当然是有的。
如：每次请求都要反射一下，获取请求的方法是否需要包装，其实可以做个缓存，不需要每次都需要解析。
当然整体思路了解，小伙伴们就可以在此基础上面自行扩展。具体的进一步优化方案，也可以来尼恩读者50+交流群中交流
总结
代码优化，是一个高手的必须课，基本功。这里尼恩给大家展示一个简单、又可以称之为极品、又是人人用得着的案例。
此案例，既能展示大家对代码优雅的追求，也能展示大家对spring框架的雄厚内功，如果面试的时候如数家珍，能让面试官爱到 “刮目相看”。
End
以上代码优化案例，已经收入《尼恩Java面试宝典》V46
硬核面试题推荐
硬核文章推荐
硬核电子书
👍《尼恩Java面试宝典》（极致经典，不断升级）全网下载超过300万次
👍尼恩Java高并发三部曲：全网下载超过200万次
👍《Java高并发核心编程-卷1（加强版）》，不断升级
👍《Java高并发核心编程-卷2（加强版）》，不断升级
👍《Java高并发核心编程-卷3（加强版）》，不断升级
👍《顶级3高架构行业案例 + 尼恩架构笔记 》N 篇+，不断添加
👍100份简历模板