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

admin

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

6 F, O6 E8 d, b$ ~4 @9 d0 r" K' u4 A

       一般我们的异常都会抛出到控制层，如果使用struts2也就是action。然后try{//正确代码实现}catch{//在里面记录错误日志}，这样咋一看是不错，代码很完美。但是如果项目中有成千上万个项目怎么办？难道在每个action的catch里面都要加入异常记录代码？很显然工作量是很大的。

  S6 a4 ?0 d+ Z
       鉴于项目中配置了数据库事务，其实也是使用了AOP 详见applicationContext-service.xml配置文件。由于配置文件的局限性这里采用注释的方式实现。之所有使用注释是可以自定义参数并实现日志的详细记录。既然使用注释，现成的没有，只有自己定义来实现需求。其实spring 注释实现的注入、hibernate的model类注释实现与数据库关联以及我们最常见Override。
0 K- I2 b1 l6 v4 V, ]# |" U- ~5 J       资料:java如何实现自定义注释http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html
# m6 ?  R' |4 D: @( r  S6 K
一、 记录日志并发送邮件通知
(1)、定义注解：
1.ServiceLog.java(各种参数类型详见上面的资料)

1. import java.lang.annotation.*;
   
2. /**
   * i# y$ h. t/ O' e/ c0 H+ I
3. * 自定义注解 拦截service  
   
4. * 创建者        张志朋
   
5. * 创建时间        2015年6月3日
   ) t" H8 F1 y, C: f5 B+ }! r
6. *
   3 {$ M/ }8 S/ p, k6 O6 Z" [- L' \
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented   
    
11. public  @interface ServiceLog {
    
12.          String description()  default "";
    
13. }

复制代码

2.ControllerLog.java
& `4 t+ j; d$ e, O% P

1. import java.lang.annotation.*;
   1 L4 D3 Q- Q4 j4 k$ U, u4 f
2. /**
   
3. * 自定义注解 拦截Controller
   4 K/ L! n0 ^6 U: n
4. * 创建者        张志朋
   
5. * 创建时间        2015年6月3日
   + Q- M& ?* a3 W$ g/ Z  y
6. *
   
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented
    
11. public @interface ControllerLog {
    3 s# V3 p7 i5 U& g
12.         String description()  default "";
    
13. }

复制代码

(2)、定义切面以及切入点
1.LogAspect.java
: K* U: D) T" w

1. /**
   
2. * 日志记录AOP
   % }) S% R8 o, t
3. * 创建者        张志朋
   7 P! p2 N# b2 e8 e
4. * 创建时间        2015年6月3日
   
5. *
   
6. */
   
7. @Component
   % B+ L( q8 c7 r0 N& P, L4 S
8. @Scope
   
9. @Aspect
   . V# c, [; ~- o& p
10. public class LogAspect {
      Y4 I0 ?1 a% `+ }: f7 F2 S
11.         //Service层切点     用于记录错误日志
    
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    : U* `0 b) V0 S* r
13.         public void serviceAspect() {
    3 j! V1 e: P: t7 g
14.                
    
15.         }
    # B+ u4 K/ `8 \
16.     /**
    * h# ]' N8 V! Y- p7 _1 r
17.      * 异常通知 用于拦截service层记录异常日志  
    
18.      * @Author        张志朋
    
19.      * @param joinPoint
    
20.      * @param e  void
    / q2 R( g( L6 _- m/ p0 a
21.      * @Date        2015年6月3日
    3 F: F$ s4 X& c
22.      * 更新日志
    : D' d6 d- q1 w; L1 U! a7 X
23.      * 2015年6月3日 张志朋  首次创建
    3 K9 t! j9 B- i+ y& x
24.      *
    " `0 B. o( O4 |; p  D0 x8 K
25.      */
    
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    6 i4 P. o) x6 W' a9 I3 }4 |  Q$ [
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    
29.                 TeacherEntity user = CommonUtil.getUser();
    & g+ }( Q+ M, j+ V2 W
30.                 String ip = AddressUtils.getIpAddr(request);
    
31.                 try {
    . a3 w* Q7 K) n2 R1 G* L
32.                         String params = "";
    
33.                         if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
    1 Y0 n* t8 v1 M6 ~8 v0 z5 r
34.                                 for (int i = 0; i < joinPoint.getArgs().length; i++) {
    
35.                                         params += JSONUtil.toJSONstring(joinPoint.getArgs()[i]) + ";";
    
36.                                 }
    * a' J% \& T* t0 k
37.                         }
    " a+ }( C5 i. m+ _$ V' H; V
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
    * U: ]: y7 H5 Z7 W
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    , }. F8 J  M0 `
40.                         String exceptionDetail = e.getMessage();//异常详细信息
    # ^3 v: D1 R' c) |1 z
41.                         String method = joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()";//异常方法
    
42.                         /*==========记录数据库异常日志==========*/  
    
43.                         Log log = new Log();
    * F7 G+ N( B* Y8 K, J) D) f
44.                         log.setDescription(description);
    
45.                         log.setExceptionCode(exceptionCode);
    , B, T" S* |( r
46.                         log.setExceptionDetail(exceptionDetail);
    
47.                         log.setMethod(method);
    
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    
49.                         log.setRequestIp(ip);// 请求IP
    
50.                         log.setParams(params);//请求参数
    0 H# }% n9 m( e6 l( g2 Z% d; e
51.                         if(null!=user){
    
52.                     log.setCreateUid(user.getUid());//用户ID
    ' i! O( P0 e0 z1 B- K
53.                     log.setCreateName(user.getNickname());//用户昵称
    
54.             }
    : j) G2 I5 R' u. r
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    ! B: [9 n# P7 z# G, J4 F9 `0 Z) H
56.                         /*==========记录数本地异常日志==========*/  
    3 I9 o0 j6 q9 |$ {$ H
57.                         //LogUtil.error(description, e);
    9 q- D! t& k1 U( T* [! l% `
58.                         /*==========发送异常日志到邮箱==========*/
    ! P: @' J. e9 Y9 L2 w
59.                         StringBuffer errorMsg = new StringBuffer();
    3 z, ?( `- i. {. C) a% ?0 q5 `7 S
60.                         errorMsg.append("异常方法:");
    
61.                         errorMsg.append(method);
    
62.                         errorMsg.append("</br>");
    3 n0 ~4 M7 X" t! z8 \, w/ _
63.                         errorMsg.append("异常类型代码:");
    . }* [" b  B1 p6 j8 g+ H
64.                         errorMsg.append(exceptionCode);
    5 m& a$ F# [, h5 I$ \/ W: D( [8 \$ Y3 l
65.                         errorMsg.append("</br>");
    , R  A2 ?. Y2 t6 `$ k
66.                         errorMsg.append("异常详细信息:");
    
67.                         errorMsg.append(exceptionDetail);
    8 E3 H& V7 y' s& G9 e
68.                         errorMsg.append("</br>");
    
69.                         log.setErrorMsg(errorMsg.toString());
    ! U, {7 @9 u! y& H' X. k& K
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    / l8 G# s' L% I) G
71.                         Client.sendError(log);
    
72.                 } catch (Exception ex) {
    ; y/ Q  Y& r! r* T9 r7 E
73.                         e.printStackTrace();
    ' g& E9 Q/ v$ ]) O9 i4 g3 G; B
74.                 }
    
75.     }
    
76.      /**
    
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    % p) q8 ^  C& V- o" R& [
78.       * @Author        张志朋
    
79.       * @param joinPoint
    ' Z: B1 h* _2 M+ L4 Y
80.       * @return
    ' u5 E9 a# S" F2 z6 n
81.       * @throws Exception  String
    
82.       * @Date        2015年6月3日
    
83.       * 更新日志
    1 W7 k; x& J/ c# Q
84.       * 2015年6月3日 张志朋  首次创建
    5 R) ?& Z, u* E! S
85.       *
    . c/ G, Z  ]& P9 h  U( `6 p9 [
86.       */
    
87.      @SuppressWarnings("rawtypes")
    + P. g0 }! S" y* A" {8 J
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    
89.              throws Exception {   
    
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    ' L- L/ E/ x7 z" M1 r
91.         String methodName = joinPoint.getSignature().getName();   
    
92.         Object[] arguments = joinPoint.getArgs();   
    8 ^6 m4 P  Y. p5 J0 {
93.         Class targetClass = Class.forName(targetName);   
    0 ^  K% Y* z0 `5 s4 V
94.         Method[] methods = targetClass.getMethods();   
    
95.         String description = "";   
    
96.          for (Method method : methods) {   
    ! u' u: i5 D7 |; }( o" n
97.              if (method.getName().equals(methodName)) {   
    : s8 B+ _- ?  N/ x0 M0 A! F
98.                 Class[] clazzs = method.getParameterTypes();   
    - _7 `8 e2 `( ~4 J) b
99.                  if (clazzs.length == arguments.length) {   
    
100.                     description = method.getAnnotation(ServiceLog. class).description();   
     
101.                      break;   
     : e" _- N/ O# u: P) D0 c
102.                 }   
     3 O# ?, O8 Q& I, n9 V+ l
103.             }   
     1 G( y+ l$ [8 Y" d8 `
104.         }   
     
105.          return description;   
     
106.     }
     6 N) D4 z& k% f5 A
107.     }

复制代码

7 V* w9 D" a, c这里说明一下  serviceAspect()方法 上面注释了 @Pointcut("@annotation(com.acts.web.aop.ServiceLog)")  、也就说明这是一个切入点，springAOP对其进行了封装。
/ W9 }, ?0 N# i. g9 [doAfterThrowing()方法上面加入了@AfterThrowing(pointcut = "serviceAspect()", throwing = "e") 对切入点的所有异常信息进行处理(记录日志到数据库或者发送错误信息到指定邮箱等等等，可以做任何你想做的事情)。

2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）
% N/ N& k/ d5 T; a5 p' U! m/ Y

1. @ServiceLog(description="获取待审试题数量")
   # J$ s; q% C2 H3 @2 ]
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   
3.                 return quesPerDao.getAuditQuesNum(currentUser);
   
4.         }

复制代码

* w, }' d) n% T* @之所以定义description 描述 是为了更好的记录错误日志 文字总是比方法名 更容易识别。
二、AOP实现权限控制
       上面说过使用动态代理的类 必须实现接口但是我们的action并没有实现接口。 JDK 的动态代理只能对实现了接口的目标类进行代理，而不实现接口的类就不能使用 JDK 的动态代理。
        还好有第三方的包为我们解决了问题。项目中引入cglib.jar，CGLIB 是针对类来实现代理，当没有实现接口的类需要代理时就需要通过 CGLIB 来实现代理了，他的原理是对指定的目标类生成一个子类，并覆盖其中方法实现增强，但是因为采用的是继承，所以不能对 finall 类进行继承。
; L5 T8 R0 {" p- [! u7 r首先配置文件要引入这样一段配置(看注释说明)：
' o" A+ N' @) p3 X' _1 U

1. <!--通知spring使用cglib而不是jdk的来生成代理方法 AOP可以拦截到Controller(Action)-->
   & X- C$ O& U: i% d5 ^
2.         <aop:aspectj-autoproxy proxy-target-class="true"/>

复制代码

7 w+ \# J! I" @9 a) ?; o& X(1)、定义注释：
1.Permission.java
! f+ C6 [/ U% O! o0 G. B% v

1. /**
   
2. * 自定义权限管理
   ) S7 l( M' \0 Y: v; g
3. * 创建者        张志朋
   # R! t7 B8 k0 Y% @/ k0 L+ r
4. * 创建时间        2015年6月30日
   6 @% x4 O5 B* a2 U4 B
5. *
   
6. */
   
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   , u% e5 R; U2 W2 y0 v1 g( G# U" W
8. @Retention(RetentionPolicy.RUNTIME)   
   9 w6 Q, `  e5 g/ z3 k6 H* e
9. @Documented
   
10. public @interface Permission {
    4 ~/ }0 K* F6 B/ }# A$ U
11.         String name()  default ""; //操作行为
    # H7 ^+ g- o+ c4 b# R
12.         int id() default -1;//权限值
      S, H. [3 ~, I% c+ g
13. }

复制代码

(2)、定义切面以及切入点
1.PsemissionAspect.java
9 u( F8 |! \8 P5 O

1. /**
   
2. * 权限管理
   % ~5 o- x1 f! ^9 n
3. * 创建者        张志朋
   
4. * 创建时间        2015年7月3日
   6 u1 X7 p1 L  s4 S! J" Y
5. *
   
6. */
   + g. L. D& i+ t: I) \, P
7. @Component
   
8. @Scope
   5 a1 ]9 g; z0 W/ E& V
9. @Aspect
   ( X7 ^& y+ T1 g, |
10. public class PsemissionAspect {
    ) f- X! X* a2 b6 |2 H7 C, a0 y9 {
11.         
    6 E3 F; W2 [0 R2 P2 ]
12.     //Controller层切点 用于权限控制
    2 g& D( B/ o, ~( m5 d, W
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
    
14.         public void permissionAspect() {
    
15.                
    
16.         }
    $ Z1 F( }" T! v7 l/ R: N: P% i, n
17.         /**
    
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    
19.          * @Author        张志朋
    0 D+ M/ @/ c- C0 S5 I
20.          * @param joinPoint  void
    
21.          * @Date        2015年6月3日
    : b) Z1 m9 z1 o2 ~9 j# \' z) B
22.          * 更新日志
    4 s8 y8 Q; x% n' {) [8 \
23.          * 2015年6月3日 张志朋  首次创建
    * _3 j9 v! k$ i7 k
24.          *
    
25.          */
    - y5 Z+ w0 R% K( F. ~: j6 G
26.     @Around("permissionAspect()")   
    & _# N) n/ R4 u; L- ]! ^5 t  }7 x% a
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    
28.         Object retVal = null;
    4 v: b: \5 x$ W; E4 q
29.                 int role  =  getControllerMethodRole(joinPoint);
    
30.                 TeacherEntity user = CommonUtil.getUser();
    % m4 _) ]4 m! f9 x& q% w2 A
31.                 if((user.getSpecRole()&role)==role){//没有权限
    ! C/ N/ j' a8 w% V4 C3 |
32.                         retVal  = joinPoint.proceed();
    
33.                 }else{
    6 y- o5 D5 l- j5 B" j, m7 U
34.                         noAuthorization();
    
35.                 }
    3 R0 D1 q' W, R
36.             return retVal;
    ! f5 R+ x! x& A
37.     }
    + \8 S  M1 U& U: W" ]  g( ^7 t: R. B8 l
38.     /**
    ) ]4 Y# Q/ R& q% P6 o
39.      * 没有权限 实现跳转
    
40.      * @Author        张志朋
    1 a: s+ p6 V: D; e2 ~- x5 z0 n
41.      * @throws IOException  void
    . o( w! b7 |) c2 b% W* c# u: F( I
42.      * @Date        2015年7月3日
    ( z& C( [0 l% F  J9 g
43.      * 更新日志
    4 X  V7 Z/ |/ r% x: F
44.      * 2015年7月3日 张志朋  首次创建
    
45.      *
    
46.      */
    5 [% w7 G1 D' y
47.     public void noAuthorization() throws IOException{
    
48.             HttpServletRequest request = ServletActionContext.getRequest();
    
49.                 String path =  request.getContextPath();
    5 m. p4 y6 q8 t
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    ) P  [  D) a( `& E
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
    
52.     }
    
53.     /**
    4 s) b+ ^* O8 u' F& G6 F
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    
55.      * @Author        张志朋
    
56.      * @param joinPoint
    % Z  F9 I* v, Y3 l# @2 c
57.      * @return
    - l+ r6 P4 O$ G6 @; t4 Z: _
58.      * @throws Exception  int
    
59.      * @Date        2015年7月3日
    
60.      * 更新日志
    
61.      * 2015年7月3日 张志朋  首次创建
    8 C2 u3 A9 R# _3 v6 k
62.      *
    
63.      */
    
64.     @SuppressWarnings("rawtypes")
    0 l3 c; C6 {: f6 ?+ i; k
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    , n6 F) `8 c2 O  g- I
67.         String methodName = joinPoint.getSignature().getName();   
    
68.         Object[] arguments = joinPoint.getArgs();   
    6 y1 `" h$ q) u) h% l1 F% Q
69.         Class targetClass = Class.forName(targetName);   
    
70.         Method[] methods = targetClass.getMethods();   
    7 Z/ |1 d. O  S% s5 H
71.         int role = -1;   
    
72.          for (Method method : methods) {   
    
73.              if (method.getName().equals(methodName)) {   
    
74.                 Class[] clazzs = method.getParameterTypes();   
    
75.                  if (clazzs.length == arguments.length) {   
    
76.                          role = method.getAnnotation(Permission. class).id();   
    $ F( E) ]" b! o# X6 v+ G
77.                      break;   
    + E) X! _: a( Y
78.                 }   
    ' ]# ]* |$ b1 }$ m6 u
79.             }   
    
80.         }   
    
81.          return role;   
    $ f( h' f6 y1 }* V  U
82.     }

复制代码

5 G5 h2 x5 A4 P0 I! @2.action层代码实现：

1. /**
   / I! p8 p( M  J) w6 R
2.          * 试题审核不通过
   
3.          * @Author        张志朋  void
   
4.          * @Date        2015年5月4日
   
5.          * 更新日志
   
6.          * 2015年5月4日 张志朋  首次创建
   
7.          *
   
8.          */
   5 L& L/ O( L" ~# F( x' w
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   ( Z3 b) j' U' J
10.         public void auditQuestions(){
    
11.                 try {
    # N8 y/ f$ ~, \% ?+ C! m/ v: L
12.                      //代码实现
    3 c+ K4 i$ i9 X- W( \4 E! e
13.                 } catch (Exception e) {
    
14.                      e.printStackTrace();
    ) [( `6 B0 d) u1 f4 R3 F5 m
15.                 }
    
16. 
    
17.         }

复制代码

* ?6 s9 i+ x" b9 r9 L( Q5 Z4 L4 `

共同研讨

真的是不错的东西 支持楼主

共同研讨

不错的东西    支持下

gaoxiang1985

支持楼主·································

毛小豆

这么近距离的看到了Aop的代码。不错。很易懂

wfymqj

过来学习高手的代码了。支持楼主！

xiaohan

楼主威武，感谢楼主

java侠

感谢楼主分享，

贝斯特

感谢 分享  

明月照大江

不错，谢谢