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

admin

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

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

3 }" i' I" O0 @# ^
       鉴于项目中配置了数据库事务，其实也是使用了AOP 详见applicationContext-service.xml配置文件。由于配置文件的局限性这里采用注释的方式实现。之所有使用注释是可以自定义参数并实现日志的详细记录。既然使用注释，现成的没有，只有自己定义来实现需求。其实spring 注释实现的注入、hibernate的model类注释实现与数据库关联以及我们最常见Override。
; c$ z: Q5 F- M       资料:java如何实现自定义注释http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html

) C1 }  O, J2 {: a+ A1 M一、 记录日志并发送邮件通知
/ D. X  l& H& J1 ?* ~( t3 A(1)、定义注解：
1.ServiceLog.java(各种参数类型详见上面的资料)
# _2 ]: \& I/ C& A9 }6 t- J" B

1. import java.lang.annotation.*;
   ( ^) S; b% T9 |- `1 Z! D
2. /**
   
3. * 自定义注解 拦截service  
   
4. * 创建者        张志朋
   % D: g# N9 \3 ~8 i- [# y
5. * 创建时间        2015年6月3日
   2 ^6 {( ~8 |) J5 v" _3 I
6. *
   
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   3 R( E9 Z3 u4 y
9. @Retention(RetentionPolicy.RUNTIME)   
   $ w# S, X3 l, J- B8 v
10. @Documented   
    ' n6 |+ u* F8 O+ n$ _" [
11. public  @interface ServiceLog {
    # S: M% ^" L4 e% K% U" s
12.          String description()  default "";
    1 ^( ?  e& `! j/ c, X" {6 s1 _
13. }

复制代码

2.ControllerLog.java

1. import java.lang.annotation.*;
   
2. /**
   
3. * 自定义注解 拦截Controller
   6 v" w, b; w! T4 ~% m
4. * 创建者        张志朋
   & R% e2 V" w3 e
5. * 创建时间        2015年6月3日
   
6. *
   
7. */
   & h7 {1 o% e& d+ @" v2 I- s
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   $ K* q+ c- d4 G! k. }* k
10. @Documented
    8 ]# G6 `# G6 A. O' m2 ~
11. public @interface ControllerLog {
    
12.         String description()  default "";
    
13. }

复制代码

(2)、定义切面以及切入点
1.LogAspect.java
8 {3 a+ V& V' v  C+ h7 T9 d

1. /**
   $ _- J- R  \' V0 J5 R) o- t
2. * 日志记录AOP
   . D# k+ X7 b' g& m+ b+ W: Y
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月3日
   
5. *
   , p- Z& a; ?- i' Y
6. */
   
7. @Component
   
8. @Scope
   
9. @Aspect
   
10. public class LogAspect {
    
11.         //Service层切点     用于记录错误日志
    0 u) ]) B( A  L! ~* u; P6 V
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    ( `) [0 T7 B* ]8 F0 u7 I! n
13.         public void serviceAspect() {
    
14.                
    * ~3 x1 |% @, @
15.         }
    # e8 D' V9 Y, ]: I
16.     /**
    : b7 w) @/ K+ s2 B/ X1 I
17.      * 异常通知 用于拦截service层记录异常日志  
    
18.      * @Author        张志朋
    
19.      * @param joinPoint
    
20.      * @param e  void
    
21.      * @Date        2015年6月3日
    8 r2 z, c& {8 l$ J9 n1 i) N
22.      * 更新日志
    4 W8 L. c& B# G1 h+ n! J7 I
23.      * 2015年6月3日 张志朋  首次创建
    & a$ n, M  d* Z: H% ^, ?
24.      *
    8 k& h2 ?5 o+ Q6 j
25.      */
    
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    9 t& K' C% P8 ]- F( ^, p
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    
29.                 TeacherEntity user = CommonUtil.getUser();
    5 U3 e: W! v. P  a2 |5 B: a. T9 D" z
30.                 String ip = AddressUtils.getIpAddr(request);
    
31.                 try {
    
32.                         String params = "";
    # n  q3 ^) C+ R$ i4 c2 y6 O
33.                         if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
    
34.                                 for (int i = 0; i < joinPoint.getArgs().length; i++) {
    
35.                                         params += JSONUtil.toJSONstring(joinPoint.getArgs()[i]) + ";";
    . [/ G7 ], o1 Y5 L. L
36.                                 }
    
37.                         }
    
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
    
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    
40.                         String exceptionDetail = e.getMessage();//异常详细信息
    6 N$ t: D1 n" N
41.                         String method = joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()";//异常方法
    
42.                         /*==========记录数据库异常日志==========*/  
    
43.                         Log log = new Log();
    
44.                         log.setDescription(description);
    
45.                         log.setExceptionCode(exceptionCode);
    
46.                         log.setExceptionDetail(exceptionDetail);
    ( d! y& I/ Q: |  d/ V6 Y: g
47.                         log.setMethod(method);
    4 \( V. v1 d7 g' d, @+ I$ w
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    
49.                         log.setRequestIp(ip);// 请求IP
    / D8 ?7 j$ i2 }( `' z) w) Z
50.                         log.setParams(params);//请求参数
    % V/ p. M' }" g) C( R1 q
51.                         if(null!=user){
    
52.                     log.setCreateUid(user.getUid());//用户ID
    + _, T, j( F% @' ^! l6 B/ i
53.                     log.setCreateName(user.getNickname());//用户昵称
    
54.             }
    
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    % ]% F7 \5 C, G3 s5 ?1 S
56.                         /*==========记录数本地异常日志==========*/  
      P& T; R) V2 R7 G# i$ l- N! `
57.                         //LogUtil.error(description, e);
    9 w3 V( @. d/ Z, ~: ~* }4 C
58.                         /*==========发送异常日志到邮箱==========*/
    & y4 A, h  }5 `; ?! E+ [/ z
59.                         StringBuffer errorMsg = new StringBuffer();
    
60.                         errorMsg.append("异常方法:");
    ' G1 d5 K' |8 i
61.                         errorMsg.append(method);
    5 c/ l. q  H: S
62.                         errorMsg.append("</br>");
    
63.                         errorMsg.append("异常类型代码:");
    $ m# r, x1 V4 c- k/ F- r
64.                         errorMsg.append(exceptionCode);
    - Y4 C7 J7 X% `- g6 z, L) t
65.                         errorMsg.append("</br>");
    5 u1 ^' f4 X+ ^' Y+ B* i
66.                         errorMsg.append("异常详细信息:");
    / L# W7 y$ p$ v" i1 c4 E! Z
67.                         errorMsg.append(exceptionDetail);
    
68.                         errorMsg.append("</br>");
    
69.                         log.setErrorMsg(errorMsg.toString());
    1 E. W! v' }6 k' P+ n; F
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    + h* |, R" K! u( o; Z5 S' V/ _
71.                         Client.sendError(log);
    
72.                 } catch (Exception ex) {
    6 s: p2 w4 R  Q* E/ e
73.                         e.printStackTrace();
    
74.                 }
    
75.     }
    , e# R3 d9 l; J9 |
76.      /**
    3 f2 e! T9 Q( J3 R$ I
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    
78.       * @Author        张志朋
    ( k6 A( p0 e% I2 }0 g
79.       * @param joinPoint
    
80.       * @return
    7 I9 ]6 }/ L" J7 K& {( l
81.       * @throws Exception  String
    * Y5 x4 A. H9 y/ ]- f/ b
82.       * @Date        2015年6月3日
    
83.       * 更新日志
    
84.       * 2015年6月3日 张志朋  首次创建
    3 G" U% C' ^( E: y0 G
85.       *
    
86.       */
    
87.      @SuppressWarnings("rawtypes")
    ( I1 e, w3 v2 y
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    8 Q4 u" g: w/ V8 m+ {% x
89.              throws Exception {   
    
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    : r! `9 Q0 Z" S: K
91.         String methodName = joinPoint.getSignature().getName();   
    6 S7 ~4 r9 X- S0 s! u  C, Q
92.         Object[] arguments = joinPoint.getArgs();   
    
93.         Class targetClass = Class.forName(targetName);   
    
94.         Method[] methods = targetClass.getMethods();   
    
95.         String description = "";   
    : S4 y5 h5 B3 [; b- O
96.          for (Method method : methods) {   
    
97.              if (method.getName().equals(methodName)) {   
    
98.                 Class[] clazzs = method.getParameterTypes();   
    3 e' G, D& r% [8 n
99.                  if (clazzs.length == arguments.length) {   
    + r$ A- Z7 _  p. c0 z$ B
100.                     description = method.getAnnotation(ServiceLog. class).description();   
     ; r+ @5 ^, I3 h9 J& M
101.                      break;   
     : x4 [8 N& t8 @% P
102.                 }   
     ( v' a# N9 f% p' P; O: |' O# t
103.             }   
     
104.         }   
     
105.          return description;   
     % m2 g: f$ i/ g$ d6 T
106.     }
     5 H9 e- ], L! u2 u! M: h
107.     }

复制代码

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

2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）

1. @ServiceLog(description="获取待审试题数量")
   
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   
3.                 return quesPerDao.getAuditQuesNum(currentUser);
     L; y3 m' S% r1 a" |, w+ c
4.         }

复制代码

之所以定义description 描述 是为了更好的记录错误日志 文字总是比方法名 更容易识别。
二、AOP实现权限控制
4 [3 e2 q! a6 B4 v+ L/ D       上面说过使用动态代理的类 必须实现接口但是我们的action并没有实现接口。 JDK 的动态代理只能对实现了接口的目标类进行代理，而不实现接口的类就不能使用 JDK 的动态代理。
$ y  m, f- m9 N3 o: y7 t        还好有第三方的包为我们解决了问题。项目中引入cglib.jar，CGLIB 是针对类来实现代理，当没有实现接口的类需要代理时就需要通过 CGLIB 来实现代理了，他的原理是对指定的目标类生成一个子类，并覆盖其中方法实现增强，但是因为采用的是继承，所以不能对 finall 类进行继承。
首先配置文件要引入这样一段配置(看注释说明)：

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

复制代码

9 [$ E, e; m' F(1)、定义注释：
1.Permission.java
8 m/ [/ L; r1 ^8 O4 y* ^2 n1 N

1. /**
   
2. * 自定义权限管理
   , c! C. q- g5 Y! ^+ ?( @
3. * 创建者        张志朋
   $ d" e) }8 B3 O6 u8 J$ s
4. * 创建时间        2015年6月30日
   ' V2 B0 y( ?, s; c! t
5. *
   - P5 ]  N; P! Q- A6 F
6. */
   # \( {0 D! w! w/ G
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   ( [, }0 [4 }( s% B* |3 I
8. @Retention(RetentionPolicy.RUNTIME)   
   
9. @Documented
   + m9 s0 T3 N$ ]  q
10. public @interface Permission {
    # N9 h6 b% K3 ^9 [' r& R
11.         String name()  default ""; //操作行为
    0 p1 v( t1 D* z8 r8 ~, Z0 i
12.         int id() default -1;//权限值
    ' x( E2 _7 l/ G
13. }

复制代码

(2)、定义切面以及切入点
: h# K! J5 C8 \' `  f3 l1.PsemissionAspect.java
5 \7 u$ u0 z+ B6 B' B

1. /**
   
2. * 权限管理
   
3. * 创建者        张志朋
   - W1 k9 w7 A$ V7 e' x7 s! R4 I/ Z1 z; M
4. * 创建时间        2015年7月3日
   & @; n0 M* ]$ W8 i5 N4 Z
5. *
   
6. */
   
7. @Component
   
8. @Scope
   , G. U5 p; X5 x4 {; `! q% z
9. @Aspect
   
10. public class PsemissionAspect {
    
11.         
    
12.     //Controller层切点 用于权限控制
    , h6 [2 M0 v7 l+ K+ A: c0 M7 C
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
      \6 t' Q2 p  K9 `0 O3 b" j0 Z7 ]
14.         public void permissionAspect() {
    0 o# p, a. c% c$ n
15.                
    
16.         }
    ! G5 d7 P9 }/ i$ X9 O
17.         /**
    
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    
19.          * @Author        张志朋
    
20.          * @param joinPoint  void
    
21.          * @Date        2015年6月3日
    
22.          * 更新日志
    ) u5 V; a0 R, F' j' C$ ?. z
23.          * 2015年6月3日 张志朋  首次创建
    
24.          *
    
25.          */
    8 t1 h( L& d: ?( o! [3 m
26.     @Around("permissionAspect()")   
    ! N! ~" _. _( q* e8 z
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    
28.         Object retVal = null;
    ( q  |* o1 z& K* V* @3 @
29.                 int role  =  getControllerMethodRole(joinPoint);
    
30.                 TeacherEntity user = CommonUtil.getUser();
    
31.                 if((user.getSpecRole()&role)==role){//没有权限
    
32.                         retVal  = joinPoint.proceed();
    ) S' G8 M+ Q' m/ h' q, T
33.                 }else{
    
34.                         noAuthorization();
    
35.                 }
    / e1 \+ G6 y3 }. T8 L! q
36.             return retVal;
    
37.     }
    7 @6 E+ H2 _  D8 i7 ]4 Q
38.     /**
    2 n# O# m8 f9 O2 _! Z5 R$ G. f
39.      * 没有权限 实现跳转
    . |0 @% f$ a9 v! x* J% [3 v' g
40.      * @Author        张志朋
    7 W/ ~2 J2 G( }9 A+ Y$ j  _- D
41.      * @throws IOException  void
    
42.      * @Date        2015年7月3日
    
43.      * 更新日志
    
44.      * 2015年7月3日 张志朋  首次创建
    & [7 I- B6 r" Y9 n
45.      *
    ( }6 {6 l. |5 K8 c' W# `3 q
46.      */
    
47.     public void noAuthorization() throws IOException{
    $ V- s+ c; U5 U% Q" c3 m
48.             HttpServletRequest request = ServletActionContext.getRequest();
      B6 f( h2 z: y  M# D
49.                 String path =  request.getContextPath();
    ; H7 [; C+ S4 A2 s/ u" y" ^+ U
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    1 J/ Z( ?0 l( z$ E
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
    0 C5 m6 h+ @: k8 n; ?7 M5 C3 k* v
52.     }
    3 V5 w; v! _3 U
53.     /**
    
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    ) Y- N+ }. ^9 ?+ i2 }
55.      * @Author        张志朋
    
56.      * @param joinPoint
    
57.      * @return
    5 c$ x  |$ j" I* S! I  C; F
58.      * @throws Exception  int
    
59.      * @Date        2015年7月3日
    
60.      * 更新日志
    
61.      * 2015年7月3日 张志朋  首次创建
    2 K1 z# ~  W- w$ ]7 R+ o- T. Y& I
62.      *
    : n- r, @" H' ~) k
63.      */
    - U' x/ g/ Q+ Z6 T
64.     @SuppressWarnings("rawtypes")
    ! h+ S% X/ T7 {8 q/ d8 v' t
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    
67.         String methodName = joinPoint.getSignature().getName();   
    2 f; o. r3 U1 Y. w
68.         Object[] arguments = joinPoint.getArgs();   
    ) ?. O3 X& n. V9 ?6 B
69.         Class targetClass = Class.forName(targetName);   
    
70.         Method[] methods = targetClass.getMethods();   
    # Q( R2 |* ?$ z% t0 F
71.         int role = -1;   
    # h( o2 m) u" {9 V# \) a+ Z
72.          for (Method method : methods) {   
    . _4 ]/ W6 ]( \( T; ^! F: F
73.              if (method.getName().equals(methodName)) {   
    " V( a5 r9 ?6 ]* y; y
74.                 Class[] clazzs = method.getParameterTypes();   
    
75.                  if (clazzs.length == arguments.length) {   
    1 @" t  O- J& E' ~, k) V
76.                          role = method.getAnnotation(Permission. class).id();   
    
77.                      break;   
    0 @1 y" P$ Z4 u1 i
78.                 }   
    
79.             }   
    
80.         }   
    2 ~4 K. l1 L/ Z( ]3 L
81.          return role;   
    / x' t9 E! B9 a. D" A! i: F8 A# d
82.     }

复制代码

2.action层代码实现：

1. /**
   
2.          * 试题审核不通过
   $ S6 Z% E7 D9 L! [. V
3.          * @Author        张志朋  void
     c2 W& U1 m4 B. g
4.          * @Date        2015年5月4日
   
5.          * 更新日志
   
6.          * 2015年5月4日 张志朋  首次创建
   8 }1 U, n1 ?" U% n' e# G
7.          *
   
8.          */
   ( N8 v7 ^9 F) P" ~. F
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   
10.         public void auditQuestions(){
    9 u- u, R* z  ^: m* }% ?5 n
11.                 try {
      a. l! f3 o+ B' U7 f3 D$ L
12.                      //代码实现
    ! f" \$ z3 ?) f1 o  n
13.                 } catch (Exception e) {
    
14.                      e.printStackTrace();
    
15.                 }
    
16. 
    
17.         }

复制代码

+ F+ B9 o" [& w9 g' w$ o' Z- s
4 S, U+ M/ U* J% [

共同研讨

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

共同研讨

不错的东西    支持下

gaoxiang1985

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

毛小豆

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

wfymqj

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

xiaohan

楼主威武，感谢楼主

java侠

感谢楼主分享，

贝斯特

感谢 分享  

明月照大江

不错，谢谢