springAOP实现的异常日志记录+异常邮件发送+权限控制

admin

    忙里偷闲最近在看关于springAop的一些功能、顺便完善一下项目。

       一般我们的异常都会抛出到控制层，如果使用struts2也就是action。然后try{//正确代码实现}catch{//在里面记录错误日志}，这样咋一看是不错，代码很完美。但是如果项目中有成千上万个项目怎么办？难道在每个action的catch里面都要加入异常记录代码？很显然工作量是很大的。
, R5 v6 J6 u; k3 B8 B: w
0 n( }; t( c5 t, b0 K* D' r
* O' q3 ]* f: B( @4 b# m       鉴于项目中配置了数据库事务，其实也是使用了AOP 详见applicationContext-service.xml配置文件。由于配置文件的局限性这里采用注释的方式实现。之所有使用注释是可以自定义参数并实现日志的详细记录。既然使用注释，现成的没有，只有自己定义来实现需求。其实spring 注释实现的注入、hibernate的model类注释实现与数据库关联以及我们最常见Override。
# \! y1 C1 s" f# q( a6 g0 I       资料:java如何实现自定义注释http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html
1 X+ a3 G1 A4 s" G  n
1 J) v& P% a2 m3 U& |8 V一、 记录日志并发送邮件通知
(1)、定义注解：
1.ServiceLog.java(各种参数类型详见上面的资料)

1. import java.lang.annotation.*;
     l* L7 f( V* n- d
2. /**
   
3. * 自定义注解 拦截service  
   
4. * 创建者        张志朋
     j+ ]* j) U8 V8 R0 `! h+ |2 J
5. * 创建时间        2015年6月3日
   6 J7 J9 J6 a! \. s6 P( x. L. I% y
6. *
   / K3 q' i, E/ f6 h
7. */
   " s- ]# K& a! b+ K2 J9 x
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   # H% d  k2 l  ^' i& q( s1 W* Z
9. @Retention(RetentionPolicy.RUNTIME)   
   * ?3 X& _( M/ ?& C' y
10. @Documented   
    
11. public  @interface ServiceLog {
    - ?# ~( s# t5 J
12.          String description()  default "";
    
13. }

复制代码

2.ControllerLog.java
4 J8 P& R0 Z9 Z; Q

1. import java.lang.annotation.*;
   
2. /**
   5 K: j/ e& T) V8 p
3. * 自定义注解 拦截Controller
   
4. * 创建者        张志朋
   7 G' A' c# k) \4 ?
5. * 创建时间        2015年6月3日
   ) b. f1 E2 z. f
6. *
   
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented
    
11. public @interface ControllerLog {
    6 {. i) g$ j# H$ L& |/ @0 A. a2 J
12.         String description()  default "";
    9 N- K' ^: L3 O8 D  q# L
13. }

复制代码

(2)、定义切面以及切入点
1.LogAspect.java
2 L" V; B5 t" U8 H$ I

1. /**
   
2. * 日志记录AOP
   
3. * 创建者        张志朋
   ; V( o  p' b% q8 ]" w8 c& q' `
4. * 创建时间        2015年6月3日
   
5. *
   
6. */
   % G. j$ b1 s3 v, u+ G2 R
7. @Component
   
8. @Scope
   
9. @Aspect
   " C: E* a# e  B+ ?; H/ Z# l, b
10. public class LogAspect {
    # ]! f! E  t8 g4 f2 a
11.         //Service层切点     用于记录错误日志
    3 ^" Z; l7 [1 a
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    ! H3 \, T9 J0 Z0 I, k
13.         public void serviceAspect() {
    
14.                
    / o" n8 e" h% V! u* e
15.         }
    
16.     /**
    3 p- x0 Y- ?3 k' U8 j6 @/ r/ k
17.      * 异常通知 用于拦截service层记录异常日志  
    
18.      * @Author        张志朋
    ! [% r, p# j9 c: P! f$ `5 }7 v
19.      * @param joinPoint
    
20.      * @param e  void
    
21.      * @Date        2015年6月3日
    5 Z7 h; L" m5 u- g0 @5 g, k
22.      * 更新日志
    , m' O  l. l8 b8 p4 y$ i% c
23.      * 2015年6月3日 张志朋  首次创建
    ; M0 i' L, T4 `( c5 L- h( m3 I! T
24.      *
    
25.      */
    
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    4 v# Q6 N5 I! X& T+ ^7 i( I% }; r
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    
29.                 TeacherEntity user = CommonUtil.getUser();
    6 ]: ~' T1 ?. _7 h" H0 {8 }
30.                 String ip = AddressUtils.getIpAddr(request);
    ' O, w) t! z  A& a5 n9 w" h& G
31.                 try {
    ' m# u+ H' W& h5 i
32.                         String params = "";
    
33.                         if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
    
34.                                 for (int i = 0; i < joinPoint.getArgs().length; i++) {
    6 \, W; w& P$ i
35.                                         params += JSONUtil.toJSONstring(joinPoint.getArgs()[i]) + ";";
    # o1 U7 C, d7 n' G( t7 v
36.                                 }
    
37.                         }
    , y7 e0 R6 s1 b0 U5 i
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
    5 W& r; C6 k( ^& J% H
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    " s* w/ I( {. e
40.                         String exceptionDetail = e.getMessage();//异常详细信息
    - V  M+ _) Z8 @8 v& T  `
41.                         String method = joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()";//异常方法
    
42.                         /*==========记录数据库异常日志==========*/  
    ) @: f1 w- e0 g% K; z
43.                         Log log = new Log();
    
44.                         log.setDescription(description);
    
45.                         log.setExceptionCode(exceptionCode);
    
46.                         log.setExceptionDetail(exceptionDetail);
    
47.                         log.setMethod(method);
    
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    
49.                         log.setRequestIp(ip);// 请求IP
    
50.                         log.setParams(params);//请求参数
    9 v! o: u/ ]& ~
51.                         if(null!=user){
    0 _' S7 A. \. y
52.                     log.setCreateUid(user.getUid());//用户ID
    / r. X8 l8 I: ~, C  ?8 M  |0 z1 O
53.                     log.setCreateName(user.getNickname());//用户昵称
    
54.             }
    
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    , n/ @- y5 A3 Q
56.                         /*==========记录数本地异常日志==========*/  
    
57.                         //LogUtil.error(description, e);
    
58.                         /*==========发送异常日志到邮箱==========*/
    
59.                         StringBuffer errorMsg = new StringBuffer();
    
60.                         errorMsg.append("异常方法:");
    
61.                         errorMsg.append(method);
    6 A8 p, r, b  }% w
62.                         errorMsg.append("</br>");
    
63.                         errorMsg.append("异常类型代码:");
    
64.                         errorMsg.append(exceptionCode);
    
65.                         errorMsg.append("</br>");
    
66.                         errorMsg.append("异常详细信息:");
    
67.                         errorMsg.append(exceptionDetail);
    
68.                         errorMsg.append("</br>");
    
69.                         log.setErrorMsg(errorMsg.toString());
      A1 j/ K1 m- x& M
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    
71.                         Client.sendError(log);
    
72.                 } catch (Exception ex) {
    
73.                         e.printStackTrace();
    
74.                 }
    ; S$ W" n" u: `8 O* A! g
75.     }
    ) p. x, I  |; T6 B3 ^0 J
76.      /**
    
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    9 Q! \4 v/ z0 i% s% Z
78.       * @Author        张志朋
    
79.       * @param joinPoint
    1 W: J& d& v  Y0 V1 G/ g) v1 T
80.       * @return
    
81.       * @throws Exception  String
    7 `& N* Y+ c" P% c( c& [
82.       * @Date        2015年6月3日
    
83.       * 更新日志
    
84.       * 2015年6月3日 张志朋  首次创建
    
85.       *
    # D- Z  C9 w& J1 J
86.       */
    & V  i' S( C4 \- A8 Z7 g
87.      @SuppressWarnings("rawtypes")
    ' M5 {/ ]5 r' e  {
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    
89.              throws Exception {   
    
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    
91.         String methodName = joinPoint.getSignature().getName();   
    2 B8 O- R  v8 d
92.         Object[] arguments = joinPoint.getArgs();   
    8 n) E0 Y9 x; m  g5 d3 o# v$ Z3 Y
93.         Class targetClass = Class.forName(targetName);   
    / k& q+ K/ x& ~; e# f6 }4 ]
94.         Method[] methods = targetClass.getMethods();   
    5 w3 l: J0 [7 Q/ q# X' A" S4 W3 k' c
95.         String description = "";   
    
96.          for (Method method : methods) {   
    
97.              if (method.getName().equals(methodName)) {   
    ) s/ |, I$ t& B( ?
98.                 Class[] clazzs = method.getParameterTypes();   
    
99.                  if (clazzs.length == arguments.length) {   
    
100.                     description = method.getAnnotation(ServiceLog. class).description();   
     
101.                      break;   
     
102.                 }   
     
103.             }   
     5 L2 X1 [. J3 F. n: r5 T% Z- U
104.         }   
     
105.          return description;   
     5 I7 Y$ J1 S' h; u. A1 c
106.     }
     
107.     }

复制代码

7 E: s8 v1 H" |. E2 `这里说明一下  serviceAspect()方法 上面注释了 @Pointcut("@annotation(com.acts.web.aop.ServiceLog)")  、也就说明这是一个切入点，springAOP对其进行了封装。
doAfterThrowing()方法上面加入了@AfterThrowing(pointcut = "serviceAspect()", throwing = "e") 对切入点的所有异常信息进行处理(记录日志到数据库或者发送错误信息到指定邮箱等等等，可以做任何你想做的事情)。
( h6 Z/ \! T' v8 s/ }) s
2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）

1. @ServiceLog(description="获取待审试题数量")
   
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   - u" D" k1 l/ u0 T' W
3.                 return quesPerDao.getAuditQuesNum(currentUser);
   
4.         }

复制代码

之所以定义description 描述 是为了更好的记录错误日志 文字总是比方法名 更容易识别。
# u" [* B, T( ^1 [" q* c# C3 i二、AOP实现权限控制
0 `" q& J) a' \/ Y& S" a" z  f% \       上面说过使用动态代理的类 必须实现接口但是我们的action并没有实现接口。 JDK 的动态代理只能对实现了接口的目标类进行代理，而不实现接口的类就不能使用 JDK 的动态代理。
8 p6 J3 N1 `, X7 s- z        还好有第三方的包为我们解决了问题。项目中引入cglib.jar，CGLIB 是针对类来实现代理，当没有实现接口的类需要代理时就需要通过 CGLIB 来实现代理了，他的原理是对指定的目标类生成一个子类，并覆盖其中方法实现增强，但是因为采用的是继承，所以不能对 finall 类进行继承。
首先配置文件要引入这样一段配置(看注释说明)：

1. <!--通知spring使用cglib而不是jdk的来生成代理方法 AOP可以拦截到Controller(Action)-->
   : o# l; y& u, U1 T( s
2.         <aop:aspectj-autoproxy proxy-target-class="true"/>

复制代码

& g+ P. p+ T8 m0 b8 E7 f4 b(1)、定义注释：
" `. w) f! @7 D+ Y" b4 O: m1.Permission.java
2 P' o$ \) m5 o4 J3 h; g

1. /**
   & ]: o- x* F* i% g7 r  W! }
2. * 自定义权限管理
   0 j( |: Z: L& _# P7 |8 b
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月30日
   ( G) N$ u; m$ ?/ ]  Q9 I
5. *
   
6. */
   
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
8. @Retention(RetentionPolicy.RUNTIME)   
   8 h4 _+ x5 Y  h" i9 p* i
9. @Documented
   
10. public @interface Permission {
    
11.         String name()  default ""; //操作行为
    . _- t9 G4 P% d7 W* n! ?6 ]% T, Y
12.         int id() default -1;//权限值
    ) ?2 ]8 x. b& k( r, x! R4 P
13. }

复制代码

(2)、定义切面以及切入点
8 s7 u1 T0 b2 V1.PsemissionAspect.java
/ A" t% F7 F. p' B+ r3 p. o

1. /**
   
2. * 权限管理
   
3. * 创建者        张志朋
   
4. * 创建时间        2015年7月3日
   
5. *
   
6. */
   5 r! n' O' J- j$ U  D
7. @Component
   * v3 N5 S$ Q6 k) P: d4 z
8. @Scope
   9 A) P5 O, ^( T
9. @Aspect
   
10. public class PsemissionAspect {
    
11.         
    : Z1 @  i% n% s6 \, k6 {1 ^; G" s
12.     //Controller层切点 用于权限控制
      I/ ?7 T- ?7 f* H: r' J7 c8 N4 w( [
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
    
14.         public void permissionAspect() {
    7 [5 i$ Z& H6 N6 P- N$ u: u
15.                
    
16.         }
    
17.         /**
    : r6 L4 D0 n2 l5 N2 s+ {/ S7 H, @
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    
19.          * @Author        张志朋
    % D% i8 S' H& i( t0 y
20.          * @param joinPoint  void
    ' h% L8 ~  z! N: B* i
21.          * @Date        2015年6月3日
    1 I' [+ X! S: F7 X" o* x1 `( g* w
22.          * 更新日志
    
23.          * 2015年6月3日 张志朋  首次创建
    0 C! x: j; h% P0 ~9 R. p( |
24.          *
    , P( q6 [! o4 x5 ]
25.          */
    . [3 Q2 r$ O! r7 ]. b5 K
26.     @Around("permissionAspect()")   
    
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    
28.         Object retVal = null;
    1 ]6 t1 P7 A& X* Z  n
29.                 int role  =  getControllerMethodRole(joinPoint);
    1 A, D! F6 f- A: K
30.                 TeacherEntity user = CommonUtil.getUser();
    : W/ l! h1 r! L& R0 m
31.                 if((user.getSpecRole()&role)==role){//没有权限
    
32.                         retVal  = joinPoint.proceed();
    
33.                 }else{
    $ t" M7 B# Z& K; s/ y7 y! H1 J% F
34.                         noAuthorization();
    
35.                 }
    9 V( x" Z9 e  b
36.             return retVal;
    # g* }  U4 ?# d2 ]7 u4 O! b+ Y
37.     }
    
38.     /**
    # M. y; j) [0 {# l( C; t# P5 ~- l2 G
39.      * 没有权限 实现跳转
    * ?" u$ ^% a! x2 z" R6 N
40.      * @Author        张志朋
    
41.      * @throws IOException  void
    
42.      * @Date        2015年7月3日
    
43.      * 更新日志
    
44.      * 2015年7月3日 张志朋  首次创建
    . a3 @- Q+ m4 \! M9 g& m& n
45.      *
    
46.      */
    
47.     public void noAuthorization() throws IOException{
    
48.             HttpServletRequest request = ServletActionContext.getRequest();
    
49.                 String path =  request.getContextPath();
    " L; r# Y3 H! Q5 E6 ^7 O/ W9 ~
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
    $ X+ y/ S1 ^& A9 _% `
52.     }
    
53.     /**
    $ v% X& t: L5 R9 B" n+ p# ~% b
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    
55.      * @Author        张志朋
    
56.      * @param joinPoint
    
57.      * @return
    
58.      * @throws Exception  int
    
59.      * @Date        2015年7月3日
    % ]/ u  l5 z8 ~9 g5 K) k; \  r
60.      * 更新日志
    
61.      * 2015年7月3日 张志朋  首次创建
    3 w& }5 X8 Z; m
62.      *
    
63.      */
    
64.     @SuppressWarnings("rawtypes")
    ' n4 l5 m8 @- p# ~9 i$ S; f- [: e
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    ; w7 o1 H1 o4 y$ ?) A
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    / ]3 k, p& k/ b  M6 S
67.         String methodName = joinPoint.getSignature().getName();   
    
68.         Object[] arguments = joinPoint.getArgs();   
    # I& y' ]3 O/ Z7 s1 m
69.         Class targetClass = Class.forName(targetName);   
    
70.         Method[] methods = targetClass.getMethods();   
    
71.         int role = -1;   
    
72.          for (Method method : methods) {   
    ( S& i. y/ B, Y4 _' V. u7 z
73.              if (method.getName().equals(methodName)) {   
    
74.                 Class[] clazzs = method.getParameterTypes();   
    $ G" i$ G  n2 e. ?8 v- H
75.                  if (clazzs.length == arguments.length) {   
    ! W# i* I! N0 _9 e
76.                          role = method.getAnnotation(Permission. class).id();   
    
77.                      break;   
    7 f, u, p8 @9 s! H- q! x7 i1 H! g
78.                 }   
    0 s, ]  q1 `4 B4 J9 G! X: c! P- D
79.             }   
    
80.         }   
    ! c" N6 l/ Q% t9 N7 r" q# n, V
81.          return role;   
    9 M8 A4 y3 {* g2 x+ e4 F- B& ?
82.     }

复制代码

2.action层代码实现：

1. /**
   ; [( P7 J: |/ V7 B2 U
2.          * 试题审核不通过
   
3.          * @Author        张志朋  void
   
4.          * @Date        2015年5月4日
   
5.          * 更新日志
   
6.          * 2015年5月4日 张志朋  首次创建
   " w8 H- b% y7 b$ z6 q5 t
7.          *
   
8.          */
   $ R) {4 ]1 j$ o( e5 s! D- s
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   % T; ]; J# m3 s, {. K# m+ e9 }7 k
10.         public void auditQuestions(){
    % T! v2 S) F) {4 v3 Z$ n
11.                 try {
    
12.                      //代码实现
    2 I6 l2 v1 |- o. y/ b
13.                 } catch (Exception e) {
    9 I6 B3 q+ v8 \8 x; O
14.                      e.printStackTrace();
    
15.                 }
    
16. 
    
17.         }

复制代码

1 B6 l  g8 T( u, @! h0 o
- j( y& c$ F9 x6 A8 H

zcl001001

学习学习，参考下开发

zrszrs

x'x'x'x'x'x'x

奈何、

学习学习。

劉様

不错不错

花生壳

花生壳到此一逛

春天

好东西            谢谢分享

辉大大

很不错很不错很不错很不错很不错很不错很不错

我的老家

admin 发表于 2016-11-23 13:24
有

! F9 `' V: W: P3 [* o' s好的 谢谢了  麻烦你了

淡定240

不错，受用了，谢谢分享