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

admin

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

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


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

0 U- u! ]/ A% g" r$ S一、 记录日志并发送邮件通知
8 w- F+ p. ?1 c2 w+ `(1)、定义注解：
) L: G) g) Q% k) w1.ServiceLog.java(各种参数类型详见上面的资料)
, \+ _: ]: {9 w3 H

1. import java.lang.annotation.*;
   
2. /**
   0 r6 s# b. v3 p
3. * 自定义注解 拦截service  
   
4. * 创建者        张志朋
   ; x  ~2 J6 f6 g  I2 A' k0 p
5. * 创建时间        2015年6月3日
   
6. *
   
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented   
    : K* {5 f& S2 o0 P: A5 t- _  z5 U
11. public  @interface ServiceLog {
      J( D! w1 K: `4 }8 Q- f2 y3 l+ W0 \
12.          String description()  default "";
    5 {; i' Y' d& c: H3 K# ]+ I4 U
13. }

复制代码

2.ControllerLog.java
# c# L2 n/ y- R* E$ t- r: y

1. import java.lang.annotation.*;
   # s: x, X/ n; u
2. /**
   - r& ]! f+ ]. R! m1 I: n, L' G
3. * 自定义注解 拦截Controller
   
4. * 创建者        张志朋
   
5. * 创建时间        2015年6月3日
   
6. *
   * y- L4 a5 Y9 m
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented
    
11. public @interface ControllerLog {
    
12.         String description()  default "";
    , v5 i& T/ {, h6 L( {
13. }

复制代码

(2)、定义切面以及切入点
1.LogAspect.java
! T+ N$ c) S- ~, o: U

1. /**
   
2. * 日志记录AOP
   
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月3日
   , s1 u: a3 w8 a0 ?! A
5. *
   . k( l5 w6 z! y) I
6. */
   
7. @Component
   7 i+ R8 S3 j8 U6 V
8. @Scope
   4 |) t# x3 W$ ~. z+ x
9. @Aspect
   
10. public class LogAspect {
    
11.         //Service层切点     用于记录错误日志
    
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    
13.         public void serviceAspect() {
    
14.                
    
15.         }
    9 d3 S5 T  e7 k0 `" k
16.     /**
    9 v7 }/ n; i2 w3 q) {1 t
17.      * 异常通知 用于拦截service层记录异常日志  
    9 v; S9 K' W% o7 A; l7 z
18.      * @Author        张志朋
    $ T. Q/ i' f7 e; |7 ^9 n7 x
19.      * @param joinPoint
    , {% q% y) v6 V, b' B6 y
20.      * @param e  void
    
21.      * @Date        2015年6月3日
    1 r" I  Q1 j" W0 d* N) N  t' }6 w
22.      * 更新日志
    
23.      * 2015年6月3日 张志朋  首次创建
    3 y$ a" i0 N9 a) M- b
24.      *
    6 Z# ?" m, J' |* N! Q
25.      */
    
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    
29.                 TeacherEntity user = CommonUtil.getUser();
    + y0 h% _& H9 ~7 p% F2 x* ?
30.                 String ip = AddressUtils.getIpAddr(request);
    6 d4 H5 }3 k# C
31.                 try {
    
32.                         String params = "";
    
33.                         if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
    / L* I+ f8 L  g7 I+ R
34.                                 for (int i = 0; i < joinPoint.getArgs().length; i++) {
    3 c; _8 ~$ K) C/ y9 K, s$ D4 f
35.                                         params += JSONUtil.toJSONstring(joinPoint.getArgs()[i]) + ";";
    
36.                                 }
    / L8 o) [- P2 E' r3 i
37.                         }
    
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
    . I6 B, M6 s3 |9 T8 R
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    
40.                         String exceptionDetail = e.getMessage();//异常详细信息
    ; o5 t% B3 m9 @0 u" ^: X- N6 |
41.                         String method = joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()";//异常方法
    / o0 y$ j* o; ?$ `
42.                         /*==========记录数据库异常日志==========*/  
    ! i. `3 v) T# ?) v  n3 c: p
43.                         Log log = new Log();
    
44.                         log.setDescription(description);
    
45.                         log.setExceptionCode(exceptionCode);
    
46.                         log.setExceptionDetail(exceptionDetail);
    # @+ [" G# f4 }
47.                         log.setMethod(method);
    
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    
49.                         log.setRequestIp(ip);// 请求IP
    
50.                         log.setParams(params);//请求参数
    
51.                         if(null!=user){
    ! x+ z9 f0 x" a6 A
52.                     log.setCreateUid(user.getUid());//用户ID
    
53.                     log.setCreateName(user.getNickname());//用户昵称
    ! M' A$ {( r$ g/ d, a
54.             }
    
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    5 T4 g* t9 j' T2 R
56.                         /*==========记录数本地异常日志==========*/  
    
57.                         //LogUtil.error(description, e);
    ( Q( M# T$ w2 T' |( x
58.                         /*==========发送异常日志到邮箱==========*/
    ( Q& D0 K" X, ~; d, l
59.                         StringBuffer errorMsg = new StringBuffer();
    , `* q' G* G% P4 P7 R" V$ a
60.                         errorMsg.append("异常方法:");
    7 ]5 x, |8 P$ d( K6 M3 T
61.                         errorMsg.append(method);
    
62.                         errorMsg.append("</br>");
    ' i0 l; ~& ~, t- T$ A
63.                         errorMsg.append("异常类型代码:");
    6 D$ K4 F5 m; }$ y; i  m
64.                         errorMsg.append(exceptionCode);
    ; |, E. h5 l" H, \/ F) U* ?
65.                         errorMsg.append("</br>");
    % A8 B- Y( m5 R- k1 o; W  X
66.                         errorMsg.append("异常详细信息:");
    * U9 z3 ]8 K$ l  _3 q$ ]
67.                         errorMsg.append(exceptionDetail);
      `1 o6 y' ?$ Q% \
68.                         errorMsg.append("</br>");
    
69.                         log.setErrorMsg(errorMsg.toString());
    
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    % c6 W" a8 q; ?2 M# Q! C
71.                         Client.sendError(log);
    
72.                 } catch (Exception ex) {
    
73.                         e.printStackTrace();
    
74.                 }
    
75.     }
    , m3 n4 X2 L1 \* N" ^- }7 {, A
76.      /**
    2 ?$ @) ~. @  w- w
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    
78.       * @Author        张志朋
    
79.       * @param joinPoint
    * ^$ Z: r3 l7 Z$ |) c& Z
80.       * @return
    , z6 W% Z5 ?  M2 p3 X
81.       * @throws Exception  String
    
82.       * @Date        2015年6月3日
    8 ]! R1 z" J* E
83.       * 更新日志
    . V0 O# M8 R7 |' E
84.       * 2015年6月3日 张志朋  首次创建
    4 v+ j. k* G+ a
85.       *
    ' g& u$ U# B7 }* N8 K& m# Q, Q4 n" y
86.       */
    # P9 C$ Q$ x# _, w! g* C
87.      @SuppressWarnings("rawtypes")
    6 I" f8 E1 j2 r& K
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    
89.              throws Exception {   
    3 ]' L5 P) k2 Q3 O" f
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    : _1 b7 m7 X' h' b# w2 k% i2 I
91.         String methodName = joinPoint.getSignature().getName();   
    / k0 T1 h+ \4 z0 \- F2 k2 S
92.         Object[] arguments = joinPoint.getArgs();   
    
93.         Class targetClass = Class.forName(targetName);   
    ; r  p% ^8 l% d  {
94.         Method[] methods = targetClass.getMethods();   
    
95.         String description = "";   
    
96.          for (Method method : methods) {   
    8 O& Q3 [% N* Y2 G% j
97.              if (method.getName().equals(methodName)) {   
    
98.                 Class[] clazzs = method.getParameterTypes();   
    
99.                  if (clazzs.length == arguments.length) {   
    
100.                     description = method.getAnnotation(ServiceLog. class).description();   
     
101.                      break;   
     * m/ z/ S  O' o  V7 }/ Z
102.                 }   
     
103.             }   
     
104.         }   
     
105.          return description;   
     
106.     }
     
107.     }

复制代码

. N0 n& p3 ^; H* t, a) n这里说明一下  serviceAspect()方法 上面注释了 @Pointcut("@annotation(com.acts.web.aop.ServiceLog)")  、也就说明这是一个切入点，springAOP对其进行了封装。
1 T- i9 s( o: l2 w4 k, E6 @9 g& rdoAfterThrowing()方法上面加入了@AfterThrowing(pointcut = "serviceAspect()", throwing = "e") 对切入点的所有异常信息进行处理(记录日志到数据库或者发送错误信息到指定邮箱等等等，可以做任何你想做的事情)。
: ?" C/ E7 J* r  u6 {7 J# I( }
5 l; H  S. L4 {+ \2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）

1. @ServiceLog(description="获取待审试题数量")
   
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   
3.                 return quesPerDao.getAuditQuesNum(currentUser);
   
4.         }

复制代码

之所以定义description 描述 是为了更好的记录错误日志 文字总是比方法名 更容易识别。
二、AOP实现权限控制
. n% h# w2 d; [" `       上面说过使用动态代理的类 必须实现接口但是我们的action并没有实现接口。 JDK 的动态代理只能对实现了接口的目标类进行代理，而不实现接口的类就不能使用 JDK 的动态代理。
& H# v( _8 R3 ]( V        还好有第三方的包为我们解决了问题。项目中引入cglib.jar，CGLIB 是针对类来实现代理，当没有实现接口的类需要代理时就需要通过 CGLIB 来实现代理了，他的原理是对指定的目标类生成一个子类，并覆盖其中方法实现增强，但是因为采用的是继承，所以不能对 finall 类进行继承。
首先配置文件要引入这样一段配置(看注释说明)：
9 \  f' X( v) E! [2 V! w

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

复制代码

( E$ A; K0 }# w7 z  O0 _9 w: W(1)、定义注释：
% C) \9 s8 C  N0 B1.Permission.java

1. /**
   
2. * 自定义权限管理
   ! O+ ]8 Y' s4 _& T- Y) c4 Y
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月30日
   $ P/ [" k- b5 e+ Z3 F2 r6 K
5. *
   # _$ V+ k5 K, [+ X. P
6. */
   
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
8. @Retention(RetentionPolicy.RUNTIME)   
   
9. @Documented
   
10. public @interface Permission {
    5 P5 w  S, f/ A6 {* i, f0 A
11.         String name()  default ""; //操作行为
    - l1 j/ W- \/ k- ?/ f, u& D
12.         int id() default -1;//权限值
    
13. }

复制代码

(2)、定义切面以及切入点
1.PsemissionAspect.java
% @" v5 _$ ]  M; O' D! v. \9 ^$ M

1. /**
   
2. * 权限管理
   ( i4 P/ l6 ^: O+ ^, _
3. * 创建者        张志朋
   
4. * 创建时间        2015年7月3日
   
5. *
     t1 [0 h% ]0 J4 u
6. */
   
7. @Component
   6 m( \  m2 g& K- D* O
8. @Scope
   
9. @Aspect
   
10. public class PsemissionAspect {
    ; o: k. w1 _) `$ ^; A
11.         
    
12.     //Controller层切点 用于权限控制
    
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
    - L/ }, |, e8 |# j6 f
14.         public void permissionAspect() {
    
15.                
    , i) X. o( q6 }4 z" e
16.         }
    : {3 g1 o" `, _
17.         /**
    ; o* x0 J, |' Y/ p, W
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    
19.          * @Author        张志朋
    . M" [$ S* w. u
20.          * @param joinPoint  void
    
21.          * @Date        2015年6月3日
    6 k) Z/ G0 z# J7 {4 G- O
22.          * 更新日志
    # I. @% B) P7 k: N7 H& }8 L
23.          * 2015年6月3日 张志朋  首次创建
    
24.          *
    
25.          */
    
26.     @Around("permissionAspect()")   
    
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    
28.         Object retVal = null;
    ) r6 r3 `. }' v, N5 R* m* D' x
29.                 int role  =  getControllerMethodRole(joinPoint);
    
30.                 TeacherEntity user = CommonUtil.getUser();
    
31.                 if((user.getSpecRole()&role)==role){//没有权限
    $ E6 w6 g+ J& q4 \5 f. P
32.                         retVal  = joinPoint.proceed();
    
33.                 }else{
    ! E) G& B( @+ \- u- h' h! X
34.                         noAuthorization();
    # P/ F. D" L+ {4 {8 u
35.                 }
    
36.             return retVal;
    * s. }, U  e5 d/ w" l- b; U
37.     }
    
38.     /**
    
39.      * 没有权限 实现跳转
    
40.      * @Author        张志朋
    7 A, _  l- W  n: J" T: s
41.      * @throws IOException  void
    
42.      * @Date        2015年7月3日
    * u* ?: Q1 c) t9 J/ j/ L
43.      * 更新日志
    
44.      * 2015年7月3日 张志朋  首次创建
    1 C) O; n0 s* D% b! i, W, w
45.      *
    
46.      */
    
47.     public void noAuthorization() throws IOException{
    * t( e# P2 q4 m; x5 G" I, r
48.             HttpServletRequest request = ServletActionContext.getRequest();
    4 ]4 L  R# T' U  T  _
49.                 String path =  request.getContextPath();
    
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
    
52.     }
    
53.     /**
    
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    $ A$ a2 s4 r/ F
55.      * @Author        张志朋
    / y* m0 U& G: U5 O( y/ ^
56.      * @param joinPoint
    0 g8 x2 R+ u/ k+ ], S
57.      * @return
    
58.      * @throws Exception  int
    . q4 a* A" M2 Q0 J- ^* L, e
59.      * @Date        2015年7月3日
    0 F+ |  A. q' w: P1 ^" J
60.      * 更新日志
    
61.      * 2015年7月3日 张志朋  首次创建
    0 n3 g/ ]0 j$ \; D
62.      *
    
63.      */
    6 N5 @4 Z4 u. D3 q" a$ h0 m8 S* w
64.     @SuppressWarnings("rawtypes")
      i( {2 X1 a' ^) z/ M
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    $ o, u2 _1 s6 `- i) {$ N$ A
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    
67.         String methodName = joinPoint.getSignature().getName();   
    
68.         Object[] arguments = joinPoint.getArgs();   
    : o! S% i0 u# S
69.         Class targetClass = Class.forName(targetName);   
    
70.         Method[] methods = targetClass.getMethods();   
    
71.         int role = -1;   
    
72.          for (Method method : methods) {   
    
73.              if (method.getName().equals(methodName)) {   
    
74.                 Class[] clazzs = method.getParameterTypes();   
    5 q6 @2 U0 l- ]5 F) [; |$ O
75.                  if (clazzs.length == arguments.length) {   
    4 c% A5 V1 G* _; S0 N& e4 V. t3 F
76.                          role = method.getAnnotation(Permission. class).id();   
    
77.                      break;   
    8 q4 C9 ^% n, O1 |  }( \2 {! {9 s' \2 J& G
78.                 }   
    , H/ E) f! k( g8 o1 K
79.             }   
    
80.         }   
    
81.          return role;   
    
82.     }

复制代码

4 c/ u% [2 T: O8 D2.action层代码实现：

1. /**
   
2.          * 试题审核不通过
   + S& G+ a% L( ?
3.          * @Author        张志朋  void
   
4.          * @Date        2015年5月4日
   
5.          * 更新日志
   
6.          * 2015年5月4日 张志朋  首次创建
   & m3 |; d. Z* e7 K5 e6 y
7.          *
   
8.          */
   9 z1 g* R6 }: _5 J
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   
10.         public void auditQuestions(){
    
11.                 try {
    8 a7 a6 ]7 N! v7 w1 F
12.                      //代码实现
    
13.                 } catch (Exception e) {
    ' V* J- i4 Z. s3 g/ k9 R
14.                      e.printStackTrace();
    9 W6 [! ?2 p' e
15.                 }
    7 G0 C' B$ q$ F" k
16. 
    
17.         }

复制代码

) ?% G- q7 C- [4 ^( ^

共同研讨

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

共同研讨

不错的东西    支持下

gaoxiang1985

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

毛小豆

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

wfymqj

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

xiaohan

楼主威武，感谢楼主

java侠

感谢楼主分享，

贝斯特

感谢 分享  

明月照大江

不错，谢谢