标准化接口对内部设计&外部通讯的影响

问题与背景

对外接口标准化、对内标准化、屏蔽算法实现、统一的访问模式，可枚举的返回类型…，这些词是经常见到的，但是在日常开发中，往往对其作用感受很少，但是这确实是有意义的，因为各个大厂都在努力做这种内部产品，比如对数据库的访问，屏蔽各种数据库的差异，提供统一的访问接口，阿里是有这种统一的内部产品的。

最佳实践与总结

有一些感悟是偏感觉的，文笔有限，很难写出来，就列举几个，最佳实践吧。

controller-service-dao/mapper

这是java的web后端的经典三层的写法，在刚开始的学习的过程中几乎没有意识到这种写法的好处，只知道这是一种规范。现在，从本文这个话题，可以分析出它的一个作用，那就是屏蔽实现，controller只跟service通讯，引用时还是注入的接口，一旦换了service层的调用，只需要注入不同的service即可，不需要对前端，以及controller进行任何的修改。同理，service与mapper层的关联也是一样的，如果换了数据库的实现，只需要重新开发一套遵循标准接口的新的实现，就能在service层进行新的注入，其他的程序就无需修改。这就是屏蔽实现具体实现，用接口进行标准化通讯的好处，接口，定义的就是标准。

统一web接口

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


	private int code; // 0 代表正常  1之后的数字代表错误类型
	private String message; //  短提示
	private boolean isSuccess; //server处理是否正常
	private T data; //分析结果


}

这是在项目中使用的一个统一的web返回值，code代表异常的编号，0代表征程，message代表短提示，是直接给用户能弹框提示的。isSuccess代表的是服务端的是否出现了异常，T代表的是业务数据。 这种设计把所有的接口全部都标准化了，不管是异常还是正常，都可以被返回，被有效的枚举。

内部通讯标准化

做这种设计，需要先审视你的业务，是不是存在可以抽象出的层，层与层之间的接口要标准化，可枚举，不定制。例如，程序的输入是各种协议，各种接口，但是实际上可能也就是文本数据与图片数据，可以做一个预处理层，最终预处理层的输出是有限的就是这两种形式，但是可以兼容各种发送的数据、协议等，将之标准化为后续业务需求的标准化的对象。这也是一种形式的屏蔽具体实现，后端的业务不需要理解前端的数据对接的实现，只需要接口标准化即可。这也是做框架的一个技巧。
关于这部分内容，感悟为主，真正能写出来的很少，就先写这么多吧。