接口设计这样写接口更优雅
Posted A-Itfuture
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了接口设计这样写接口更优雅相关的知识，希望对你有一定的参考价值。
总目标：安全性，可重复调用，稳定性，追溯性
1.签名：对外提供的接口要做签名认证，认证不通过的请求不允许访问接口、提供服务。
2.加密：敏感数据在网络传输过程中应该加密。
3.IP白名单：限制请求的IP，增加IP白名单，一般在网关层处理。
4.限流：尤其是对外提供的接口，无法保障调用的频率，应该做限流处理，保障接口服务正常提供服务。
5.参数校验：即使前端做了非空，规范性校验，服务端参数仍然是非常必要的。
6.统一返回值：一个服务一套统一的数据返回结果和传参规范。
7.统一异常封装：系统报错友好提示，避免暴露出sql异常的信息给调用方。
8.请求日志：记录系统产生的日志，方便快速定位分析问题。
9.幂等设计：对于一些涉及到数据一致性的接口一定要做好幂等设计，防止数据出现重复问题。
10.限制记录条数：对于对外提供的批量接口，一定限制请求的记录条数。
11.压测：上线前我们必须对API接口做一下压力测试，知道各个接口的qps情况。以便我们能够更好的预估，需要部署多少服务器节点，对于API接口的稳定性至关重要。
12.异步处理：如果同步处理业务，耗时会非常长。这种情况下，为了提升API接口的性能，我们可以改成异步处理。
13.数据脱敏：关系到业务中用户的敏感数据要进行脱敏处理。
14.完整的接口文档
怎样正确使用函数式接口@FunctionalInterface，让你的代码更优雅！
阅读源码
其实之前在讲Lambda表达式的时候提到过，所谓的函数式接口，当然首先是一个接口，然后就是在这个接口里面只能有一个抽象方法。
这种类型的接口也称为SAM接口，即Single Abstract Method interfaces。
关于@FunctionalInterface注解
它们主要用在Lambda表达式和方法引用（实际上也可认为是Lambda表达式）上。
那么就可以使用Lambda表达式来表示该接口的一个实现(注：JAVA 8 之前一般是用匿名类实现的)：
错误例子，接口中包含了两个抽象方法，违反了函数式接口的定义，idea报错提示其不是函数式接口。
提醒：加不加@FunctionalInterface对于接口是不是函数式接口没有影响，该注解知识提醒编译器去检查该接口是否仅包含一个抽象方法
函数式接口里允许定义默认方法
函数式接口里是可以包含默认方法，因为默认方法不是抽象方法，其有一个默认实现，所以是符合函数式接口的定义的；
函数式接口里允许定义静态方法
函数式接口里是可以包含静态方法，因为静态方法不能是抽象方法，是一个已经实现了的方法，所以是符合函数式接口的定义的；
函数式接口里允许定义java.lang.Object里的public方法
函数式接口里是可以包含Object里的public方法，这些方法对于函数式接口来说，不被当成是抽象方法（虽然它们是抽象方法）；因为任何一个函数式接口的实现，默认都继承了Object类，包含了来自java.lang.Object里对这些抽象方法的实现；
JDK自带常用函数式接口
目前JDK自带的一些函数式接口已经够我们基础使用，当然你也可以自己定义使用。
Java8中对于接收两个参数的场景提供了相关的函数式接口。如下：
对于函数式接口的使用，其实这个东西有好有坏。一些人都习惯用申明接口，然后调用！这样的逻辑去实现自己的业务，当然这样的方式没有问题。但是一些抽象逻辑只有内部方法里面使用到，但是自己又想抽离优化自己的代码解构体。这个时候可以考虑下函数式接口的使用。
如上面的注释逻辑，我完全可以将分片上传函数抽到执行逻辑上去，但是这样一来。整个执行逻辑和代码设计非常臃肿(个人观点)
小结
如果你要自己定义函数式接口要注意哪些？
函数式接口里只允许声明一个抽象方法
函数式接口里是允许定义默认方法的
函数式接口里允许定义静态方法
函数式接口里允许定义java.lang.Object里的public方法
往期推荐
以上是关于接口设计这样写接口更优雅的主要内容，如果未能解决你的问题，请参考以下文章