HTTP接口设计及日志打印

骑猪看日落 2024-02-18 16:36 5阅读 0赞

#### [日志记录、性能监控的三种实现方式][Link 1] ####

*  **博客分类：**
 *  [Spring][]

一、需解决的问题

部分API有签名参数（signature），Passport首先对签名进行校验，校验通过才会执行实现方法。

第一种实现方式(Origin)：在需要签名校验的接口里写校验的代码，例如：

Java代码 ![收藏代码][icon_star.png]

1.  **boolean** isValid = accountService.validSignature(appid, signature, client\_signature); 
2.  **if** (!isValid) **return** ErrorUtil.buildError(ErrorUtil.ERR\_CODE\_COM\_SING);

第二种实现方式(Spring Interception)：利用**spring的拦截器功能**，对指定的接口进行拦截，拦截器实现签名校验算法，例如：

Xml代码 ![收藏代码][icon_star.png]

1. **<****mvc:interceptors****>**
2. **<****mvc:interceptor****>**
3. **<****mvc:mapping** path="/connect/share/\*\*" **/>**
4. **<****mvc:mapping** path="/friend/\*\*" **/>**
5. **<****mvc:mapping** path="/account/get\_bind" **/>**
6. **<****mvc:mapping** path="/account/get\_associate" **/>**
7. **<****bean** class="com.sogou.upd.passport.web.inteceptor.IdentityAndSecureInteceptor" **/>**
8. **</****mvc:interceptor****>**
9. **</****mvc:interceptors****>**

第三种实现方式(spring AOP)：自定义**注解**，对需要进行签名验证的方法添加注解，例如：

Java代码 ![收藏代码][icon_star.png]

1.  @SecureValid
2.  @ResponseBody
3.  @RequestMapping(value = "/share/add", method = RequestMethod.POST) 
4.  **public** Object addShare(HttpServletRequest req, HttpServletResponse res,InfoAPIRequestParams requestParams) \{ 
5.  　　　　... 
6.  \}

2. 日志记录功能，例如：某些接口需要记录请求和响应，执行时间，类名，方法名等日志信息。也可采用以上三种方式实现。

3. 代码性能监控问题，例如方法调用时间、次数、线程和堆栈信息等。这类问题在后一个专题提出解决方案，采用以上三种方式实现缺点太多。

以下是三种实现方式比较：

<table style="color:rgb(51,51,51); font-size:14.4444px; margin:0px; padding:0px; border-collapse:collapse; border-spacing:0px; border:1px solid silver; font-family:Verdana,Arial,Helvetica,sans-serif; line-height:24.4444px"> 
 <tbody> 
 <tr style="margin:0px; padding:0px"> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 实现方式</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 优点</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 缺点</td> 
 </tr> 
 <tr style="margin:0px; padding:0px"> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> Origin</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 不采用反射机制，性能最佳 </td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 逻辑复杂时，代码复用不好 需要在每个接口里写入相同代码（我太懒，就想写几个字母） </td> 
 </tr> 
 <tr style="margin:0px; padding:0px"> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> Spring Inter</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 非常适合对所有方法进行拦截，例如调试时打印所有方法执行时间 类似过滤器的功能，如日志处理、编码转换、权限检查 是AOP的子功能 </td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 不采用反射机制，性能有所影响 需要在xml文件里配置对哪些接口进行拦截，比较麻烦 </td> 
 </tr> 
 <tr style="margin:0px; padding:0px"> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> Spring AOP</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 使用方便，增加一个注解 非常灵活，可@Before，@After，@Around等 </td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 不采用反射机制，性能有所影响（性能对比后面详细展示） </td> 
 </tr> 
 </tbody> 
</table>

二、Spring AOP 自定义注解的实现

在Maven中加入以下以依赖：

<groupId>org.springframework</groupId>

<artifactId>spring-aop</artifactId>

<version>3.0.6.RELEASE</version>

</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-aspects</artifactId>

<version>3.0.6.RELEASE</version>

</dependency>

<groupId>org.aspectj</groupId>

<artifactId>aspectjrt</artifactId>

</dependency>

<groupId>org.aspectj</groupId>

<artifactId>aspectjweaver</artifactId>

</dependency>

<groupId>cglib</groupId>

<artifactId>cglib</artifactId>

</dependency>

在spring-\*\*\*.xml中加入spring支持，打开aop功能

头文件声明 ：

Java代码 ![收藏代码][icon_star.png]

1. <xmlns:aop="http://www.springframework.org/schema/aop"
2. http://www.springframework.org/schema/aop 
3. http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
4. 　　 
5. <aop:aspectj-autoproxy proxy-target-**class**="true"> 
6. <aop:include name="controllerAspect" /> 
7. </aop:aspectj-autoproxy> 
8. <bean id="controllerAspect" **class**="com.sogou.upd.passport.common.aspect.ControllerAspect"></bean> 
9. 
10. 　　 
11. <aop:aspectj-autoproxy>

自定义注解实现在Controller层面

Java代码 ![收藏代码][icon_star.png]

1.  /\*\*
2.   \* 对Controller进行安全和身份校验 
3.   \*/
4.  @Around("within(@org.springframework.stereotype.Controller \*) && @annotation(is)") 
5.  **public** Object validIdentityAndSecure(ProceedingJoinPoint pjp, SecureValid is) 
6.  **throws** Exception \{ 
7.   Object\[\] args = pjp.getArgs(); 
8.  //Controller中所有方法的参数，前两个分别为：Request,Response 
9.   HttpServletRequest request = (HttpServletRequest) args\[0\]; 
10. 
11.  String appid = request.getParameter("appid"); 
12. **int** app\_id = Integer.valueOf(appid); 
13.  String signature = request.getParameter("signature"); 
14.  String clientSignature = request.getParameter("client\_signature"); 
15.  String uri = request.getRequestURI(); 
16. 
17.  String provider = request.getParameter("provider"); 
18. **if** (StringUtils.isEmpty(provider)) \{ 
19.  provider = "passport"; 
20.  \} 
21. 
22. // 对appid和signature进行校验
23. **try** \{ 
24.  appService.validateAppid(app\_id); 
25. **boolean** isValid = accountService.validSignature(app\_id, signature, clientSignature); 
26. **if** (!isValid) **throw** **new** ProblemException(ErrorUtil.ERR\_CODE\_COM\_SING); 
27.  \} **catch** (Exception e) \{ 
28. **return** handleException(e, provider, uri); 
29.  \} 
30. // 继续执行接下来的代码
31.  Object retVal = **null**; 
32. **try** \{ 
33.  retVal = pjp.proceed(); 
34.  \} **catch** (Throwable e) \{ 
35. **if** (e **instanceof** Exception) \{ **return** handleException((Exception) e, provider, uri); \} 
36.  \} 
37. // 目前的接口走不到这里
38. **return** retVal; 
39.  \}

三、Spring拦截器的实现

在spring-\*\*\*.xml中加入拦截器的配置

编写拦截器实现类

Java代码 ![收藏代码][icon_star.png]

1.  **public** **class** CostTimeInteceptor **extends** HandlerInterceptorAdapter \{ 
2.  
3.  **private** **static** **final** Logger log = LoggerFactory.getLogger(CostTimeInteceptor.**class**); 
4.  
5.  @Override
6.  **public** **boolean** preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) **throws** Exception \{ 
7.  **long** startTime = System.currentTimeMillis(); 
8.   request.setAttribute("startTime", startTime); 
9.  **return** **true**; 
10.  \} 
11. 
12. @Override
13. **public** **void** postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, 
14.  ModelAndView modelAndView) **throws** Exception \{ 
15. **long** startTime = (Long) request.getAttribute("startTime"); 
16. **long** endTime = System.currentTimeMillis(); 
17. **long** executeTime = endTime - startTime; 
18. **if** (log.isInfoEnabled()) \{ 
19.  log.info("\[" \+ request.getRequestURI() + "\] executeTime : " \+ executeTime + "ms"); 
20.  \} 
21.  \} 
22. \}

四、性能对比

实验环境：对/account/get\_associate接口，并发500，压测10分钟

<table style="color:rgb(51,51,51); font-size:14.4444px; margin:0px; padding:0px; border-collapse:collapse; border-spacing:0px; border:1px solid silver; font-family:Verdana,Arial,Helvetica,sans-serif; line-height:24.4444px"> 
 <tbody> 
 <tr style="margin:0px; padding:0px"> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 指标</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> Origin</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> Spring Inter</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> Spring AOP</td> 
 </tr> 
 <tr style="margin:0px; padding:0px"> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> CPU</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> user%:26.57 sys%:10.97 cpu%:37.541 </td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> user%:26.246 sys%:10.805 cpu%:37.051 </td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> user%:24.123 sys%:9.938 cpu%:34.062 </td> 
 </tr> 
 <tr style="margin:0px; padding:0px"> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> Load</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 13.85</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 13.92&nbsp;</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 12.21&nbsp;</td> 
 </tr> 
 <tr style="margin:0px; padding:0px"> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> QPS</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 6169</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 6093.2</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 5813.27</td> 
 </tr> 
 <tr style="margin:0px; padding:0px"> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> RT</td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 0.242ms </td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 0.242ms </td> 
 <td style="font-size:1em; padding:3px; margin:0px; border:1px solid silver; border-collapse:collapse"> 0.235ms </td> 
 </tr> 
 </tbody> 
</table>

采用AOP对响应时间无明显影响

采用AOP对Load无明显影响

采用AOP对CPU无明显影响

结论：使用AOP性能方面影响可忽略

[Link 1]: http://uule.iteye.com/blog/2105492
[Spring]: http://uule.iteye.com/category/148470
[icon_star.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/4cdf67057ce147f48f0049030b9ca9f6.png