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

admin

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

$ j8 E" f" f- z& b0 u- i5 ]. U

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

3 C) H: N) E! K
3 |* z. {/ E: `; y% ]       鉴于项目中配置了数据库事务，其实也是使用了AOP 详见applicationContext-service.xml配置文件。由于配置文件的局限性这里采用注释的方式实现。之所有使用注释是可以自定义参数并实现日志的详细记录。既然使用注释，现成的没有，只有自己定义来实现需求。其实spring 注释实现的注入、hibernate的model类注释实现与数据库关联以及我们最常见Override。
5 e) @. s5 }6 |- a/ x       资料:java如何实现自定义注释http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html
2 \2 r3 X$ Z* Y6 R/ a' n; S* W7 a
4 @( a7 S6 W( H. F一、 记录日志并发送邮件通知
" a6 R$ S5 ]0 T# d2 `9 g& |( I(1)、定义注解：
1.ServiceLog.java(各种参数类型详见上面的资料)

1. import java.lang.annotation.*;
   
2. /**
   
3. * 自定义注解 拦截service  
   - f5 @* H* x/ n; }8 D3 p2 [  O
4. * 创建者        张志朋
   1 V5 \0 H0 h$ r
5. * 创建时间        2015年6月3日
   ) \6 r  n  L. b4 k) A4 m* {' s/ H9 B
6. *
   - U. I+ b+ G* v6 h
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
     `0 B5 s1 Z. I! A+ H2 Q4 N+ c( O
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented   
    * t" L) c8 T4 |, Z: q# c
11. public  @interface ServiceLog {
    
12.          String description()  default "";
      r  w1 C( H. |( X
13. }

复制代码

2.ControllerLog.java
3 M4 f' w2 Z# \7 Z: R. h3 w! Z

1. import java.lang.annotation.*;
   ' }6 Y0 F! H% J
2. /**
   9 G( g% u2 T4 n1 o+ D" V! t; [
3. * 自定义注解 拦截Controller
   
4. * 创建者        张志朋
   
5. * 创建时间        2015年6月3日
   % _' D+ N9 T. ~/ S
6. *
   
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   9 U( O4 J. {" r; C
9. @Retention(RetentionPolicy.RUNTIME)   
   & C5 G% H. v4 o4 K# Z2 n
10. @Documented
    % V8 T9 N% H$ Y) v" g6 Q  e; ?& H
11. public @interface ControllerLog {
    $ T/ o- f; V$ e% p! h1 ?8 k
12.         String description()  default "";
    , n8 Z! s; u) p; Q8 f$ u. c3 G% V
13. }

复制代码

(2)、定义切面以及切入点
1.LogAspect.java
% M; a3 t# {9 V; @3 q

1. /**
   
2. * 日志记录AOP
   
3. * 创建者        张志朋
   5 `% w* h: A) b
4. * 创建时间        2015年6月3日
   ; Q! x1 t+ j( s" x# A) ?( t9 M" A9 @9 A
5. *
   6 ]0 m, n% I% v
6. */
     }, i. r, T+ }. s' G: w( j9 ^( Q
7. @Component
   
8. @Scope
   % K7 ?& o. w( a8 ~9 A" f/ D, q
9. @Aspect
   0 i/ A* c1 x8 `
10. public class LogAspect {
    
11.         //Service层切点     用于记录错误日志
    & O! {" B1 Y& t; l. @
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    6 p- S# E6 x" B* U2 p% R& {; T4 I; n
13.         public void serviceAspect() {
    
14.                
    
15.         }
    
16.     /**
    1 B9 _' X7 f6 X8 x. C9 r% [
17.      * 异常通知 用于拦截service层记录异常日志  
    & R$ w* B! I  C9 N2 V+ Z
18.      * @Author        张志朋
    : V" ?4 p" U. ]" H) |  E( \
19.      * @param joinPoint
    
20.      * @param e  void
    
21.      * @Date        2015年6月3日
    # x- `. Q/ c" Y8 g
22.      * 更新日志
    % [' n# b9 }3 k+ u  ?: E* ^
23.      * 2015年6月3日 张志朋  首次创建
    ) g. n. w4 }& N1 J1 T! B7 V8 a9 w
24.      *
    
25.      */
    ' L4 ?/ k  V; E! D5 j, K
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    1 d$ R, `6 [6 @$ E6 N
29.                 TeacherEntity user = CommonUtil.getUser();
    
30.                 String ip = AddressUtils.getIpAddr(request);
    ! \  f+ ^0 ^& S) I: [5 Y
31.                 try {
    
32.                         String params = "";
    
33.                         if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
    " y" m/ B& }1 Y0 K- G
34.                                 for (int i = 0; i < joinPoint.getArgs().length; i++) {
    ( H& E4 t, m) Y3 `7 x) [
35.                                         params += JSONUtil.toJSONstring(joinPoint.getArgs()[i]) + ";";
    * `' ?! C3 O! e2 x8 T* b; o/ g
36.                                 }
    9 r0 }) ^, D' o" {5 h8 T2 Z5 [
37.                         }
    
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
    
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    
40.                         String exceptionDetail = e.getMessage();//异常详细信息
    
41.                         String method = joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()";//异常方法
    , a0 b: u( w- N& m0 @
42.                         /*==========记录数据库异常日志==========*/  
    , q" s7 B1 }. O6 h: g
43.                         Log log = new Log();
    
44.                         log.setDescription(description);
    $ x2 [. {8 _: J7 I$ X/ P, l! H
45.                         log.setExceptionCode(exceptionCode);
    " z/ ]: N7 T, ]4 L2 [* V2 V
46.                         log.setExceptionDetail(exceptionDetail);
    
47.                         log.setMethod(method);
    : ]7 c9 d5 z$ p3 ?
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    5 c* @/ [3 g9 @+ m
49.                         log.setRequestIp(ip);// 请求IP
    
50.                         log.setParams(params);//请求参数
    
51.                         if(null!=user){
    
52.                     log.setCreateUid(user.getUid());//用户ID
    
53.                     log.setCreateName(user.getNickname());//用户昵称
    
54.             }
    $ f- Z. k3 h  L
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    * |2 ]; u$ V- ~- B
56.                         /*==========记录数本地异常日志==========*/  
    + W% G# k/ n7 A4 w" a
57.                         //LogUtil.error(description, e);
    
58.                         /*==========发送异常日志到邮箱==========*/
    
59.                         StringBuffer errorMsg = new StringBuffer();
    , X/ M9 U: h2 ^1 X: `$ ?
60.                         errorMsg.append("异常方法:");
    
61.                         errorMsg.append(method);
    
62.                         errorMsg.append("</br>");
    * u2 c# n, Q: t8 y. o
63.                         errorMsg.append("异常类型代码:");
    9 G3 U7 d' `% F: i# K; P
64.                         errorMsg.append(exceptionCode);
    
65.                         errorMsg.append("</br>");
    1 v4 f/ V$ L7 g8 t
66.                         errorMsg.append("异常详细信息:");
    * `* c+ Y8 |/ ]/ }
67.                         errorMsg.append(exceptionDetail);
    ' Z& X! {# z: c! ^0 y
68.                         errorMsg.append("</br>");
    0 n. F: g5 J. w: D# C, T2 N/ G
69.                         log.setErrorMsg(errorMsg.toString());
    
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    ; L1 U$ v& z/ C, C* h
71.                         Client.sendError(log);
    
72.                 } catch (Exception ex) {
    
73.                         e.printStackTrace();
    
74.                 }
    
75.     }
    
76.      /**
    
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    ' s' e3 ]' I" Q8 T" p- o$ v( c
78.       * @Author        张志朋
    . s6 `2 w6 b, K, E  G5 M3 i
79.       * @param joinPoint
    2 A! C' c  A$ ^+ }9 n
80.       * @return
    . @2 Q" g, S* ^* l5 j9 M3 j, v
81.       * @throws Exception  String
    
82.       * @Date        2015年6月3日
    
83.       * 更新日志
    % ~# b! Z5 f2 d* N  Z
84.       * 2015年6月3日 张志朋  首次创建
    
85.       *
    
86.       */
    
87.      @SuppressWarnings("rawtypes")
    
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    
89.              throws Exception {   
    1 r# \8 X& i  T8 t; H4 A6 m# |
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    
91.         String methodName = joinPoint.getSignature().getName();   
    
92.         Object[] arguments = joinPoint.getArgs();   
    
93.         Class targetClass = Class.forName(targetName);   
    
94.         Method[] methods = targetClass.getMethods();   
    
95.         String description = "";   
    
96.          for (Method method : methods) {   
    3 A) s  a+ D' w7 P1 u
97.              if (method.getName().equals(methodName)) {   
    / i; l9 R( B8 Y$ e8 E
98.                 Class[] clazzs = method.getParameterTypes();   
    
99.                  if (clazzs.length == arguments.length) {   
    ' c. F7 k% e0 ~; H- K
100.                     description = method.getAnnotation(ServiceLog. class).description();   
     
101.                      break;   
     8 N% d2 B9 A0 `: |
102.                 }   
     ! G- c( `) g" D: q6 L1 Q3 \
103.             }   
     0 z  o5 g! Z7 q, Z0 y  M
104.         }   
     / i, y& \/ D1 z* ^0 y, y" y
105.          return description;   
     
106.     }
     
107.     }

复制代码

这里说明一下  serviceAspect()方法 上面注释了 @Pointcut("@annotation(com.acts.web.aop.ServiceLog)")  、也就说明这是一个切入点，springAOP对其进行了封装。
, A9 M0 C8 d5 P* L# y" TdoAfterThrowing()方法上面加入了@AfterThrowing(pointcut = "serviceAspect()", throwing = "e") 对切入点的所有异常信息进行处理(记录日志到数据库或者发送错误信息到指定邮箱等等等，可以做任何你想做的事情)。
7 @4 a$ \2 @6 S( {5 D5 r) |
/ {& |& ^7 Z/ N# w- S& I2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）
$ R3 x* |9 _! {/ Z8 d6 T/ {$ i8 W

1. @ServiceLog(description="获取待审试题数量")
   4 q$ v8 W$ h- @. n
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   2 J% O) N% u+ a6 A4 g  c
3.                 return quesPerDao.getAuditQuesNum(currentUser);
   
4.         }

复制代码

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

1. <!--通知spring使用cglib而不是jdk的来生成代理方法 AOP可以拦截到Controller(Action)-->
   % ^2 ], K; \. p2 o3 }3 b! _; |
2.         <aop:aspectj-autoproxy proxy-target-class="true"/>

复制代码

(1)、定义注释：
/ {" j/ F& a3 s% s1.Permission.java
, L( G' }0 M9 ?* N& c7 r# C% Q

1. /**
   ! l* L7 U2 ]2 V& f
2. * 自定义权限管理
   
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月30日
   8 m" ~' B* B6 z( [3 x3 n
5. *
   
6. */
   
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
8. @Retention(RetentionPolicy.RUNTIME)   
   
9. @Documented
   " y( H7 \' B: f5 F
10. public @interface Permission {
      ~+ h8 O$ B7 l6 W0 [" _
11.         String name()  default ""; //操作行为
    ( K0 P3 a5 ]& i: B% E6 Y
12.         int id() default -1;//权限值
    * L: B& w2 F% ~% p* d- H" a
13. }

复制代码

(2)、定义切面以及切入点
* f8 g4 i. R3 C+ \6 ~7 `5 K1.PsemissionAspect.java
9 V  l5 O2 \0 j

1. /**
   
2. * 权限管理
   $ r$ `6 J" c- a
3. * 创建者        张志朋
   
4. * 创建时间        2015年7月3日
   
5. *
   
6. */
   
7. @Component
   + }8 C( Z: w) K$ H
8. @Scope
   
9. @Aspect
   
10. public class PsemissionAspect {
    
11.         
    
12.     //Controller层切点 用于权限控制
    5 S. B% Y8 v& S( G+ g. }
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
    
14.         public void permissionAspect() {
    5 m6 o2 {# p& s7 Q; m
15.                
    4 A( U- R% ^5 u$ S  P
16.         }
    : O. ~1 R; C3 [: t' I) U6 }' b
17.         /**
    
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    . j4 D3 l. Y1 D' B
19.          * @Author        张志朋
    . A7 J6 j* x: }& |* y! N
20.          * @param joinPoint  void
    $ K) J/ c0 a& [, x6 V6 t
21.          * @Date        2015年6月3日
    - [2 z1 ?8 D9 B7 Y- g2 v
22.          * 更新日志
    7 a5 I4 \7 ~5 S3 I; s! K; K7 {: Y
23.          * 2015年6月3日 张志朋  首次创建
    
24.          *
    
25.          */
    7 s" @. v. d# [9 d$ V
26.     @Around("permissionAspect()")   
    
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    
28.         Object retVal = null;
    
29.                 int role  =  getControllerMethodRole(joinPoint);
    2 K) a; o1 ~; t& K& x( Y6 y+ _' `/ b
30.                 TeacherEntity user = CommonUtil.getUser();
    ; ?8 X* |  H" V7 y: e3 E; H
31.                 if((user.getSpecRole()&role)==role){//没有权限
    4 X2 \# i* N2 k' C: F$ m: A& @
32.                         retVal  = joinPoint.proceed();
    
33.                 }else{
    
34.                         noAuthorization();
    1 w+ p( p. O! o) p6 a' v, B
35.                 }
    ' S2 e& b  k% U3 E" a+ h3 F
36.             return retVal;
    
37.     }
    / I' `7 d" W, c0 n0 O/ j
38.     /**
    
39.      * 没有权限 实现跳转
    * H4 c* j6 z3 }9 _6 \9 b0 i, m8 o* V
40.      * @Author        张志朋
    7 R3 u0 V" r, G( p0 `
41.      * @throws IOException  void
    & j) f+ [8 E) b& P0 `* O# n
42.      * @Date        2015年7月3日
    
43.      * 更新日志
    5 s6 ]/ y  h% f$ n+ _  \
44.      * 2015年7月3日 张志朋  首次创建
    
45.      *
    
46.      */
    , F& Y5 s( Y1 ?1 r3 n2 N
47.     public void noAuthorization() throws IOException{
    ; b! z+ C* ^0 P4 I7 o' q8 E
48.             HttpServletRequest request = ServletActionContext.getRequest();
    ' y5 d: U3 r8 n- ]
49.                 String path =  request.getContextPath();
    
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    5 w! y+ v  s$ @2 @- ]9 j0 q. q
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
    
52.     }
    / O; R# R% R5 S6 w
53.     /**
    
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    : g7 F% W* D5 {% ?
55.      * @Author        张志朋
    
56.      * @param joinPoint
    
57.      * @return
    , b$ c/ _4 s9 p
58.      * @throws Exception  int
    1 y' g; z' ~& w! }- ?
59.      * @Date        2015年7月3日
    2 M6 I: o1 m9 \3 Y) C: F
60.      * 更新日志
    
61.      * 2015年7月3日 张志朋  首次创建
    # y, M1 u' \# M  [! l  e
62.      *
      K& m, x1 X/ @% ]4 x7 [2 i, L
63.      */
      s# U& C& p4 Y2 ]0 {; u
64.     @SuppressWarnings("rawtypes")
    9 m5 Q/ p: N1 j2 T
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    0 \  E3 k5 H! S% m& J
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    
67.         String methodName = joinPoint.getSignature().getName();   
    
68.         Object[] arguments = joinPoint.getArgs();   
    6 D: s/ h9 S: ]
69.         Class targetClass = Class.forName(targetName);   
    , G! G1 e2 ?1 Y* d& g
70.         Method[] methods = targetClass.getMethods();   
    
71.         int role = -1;   
    * Q0 J- q, }, {% O: i1 W
72.          for (Method method : methods) {   
    1 a. ^" N8 P) d
73.              if (method.getName().equals(methodName)) {   
    
74.                 Class[] clazzs = method.getParameterTypes();   
    
75.                  if (clazzs.length == arguments.length) {   
    
76.                          role = method.getAnnotation(Permission. class).id();   
    
77.                      break;   
    : e5 W  I: W/ w  j2 Y$ _  S
78.                 }   
    8 @6 B% _1 b8 G; E0 \) f
79.             }   
    7 Q# y* Y7 {) Y% j6 z  ?/ J
80.         }   
    ' x: y! D0 n8 D
81.          return role;   
    ( E1 o, t: X$ ~7 @
82.     }

复制代码

2 L7 v" `# |3 G: \0 l. k2.action层代码实现：
; e9 x8 {5 \7 _5 ]4 s6 D* U# R

1. /**
   ! U. W8 B; K1 e4 ?" m
2.          * 试题审核不通过
   
3.          * @Author        张志朋  void
   
4.          * @Date        2015年5月4日
   ) ?0 G% S) e/ d  w% K& E% ^$ \
5.          * 更新日志
   
6.          * 2015年5月4日 张志朋  首次创建
   0 D" o  Z( i! i8 X$ {: z6 [
7.          *
   0 ?% O* A9 l) ~* k
8.          */
   
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   2 j4 U4 T( ?7 P; g; s
10.         public void auditQuestions(){
    % a4 z, ]/ F3 b" ~: F9 |
11.                 try {
    " {5 O4 _1 I% L
12.                      //代码实现
    ( Z- |. B6 F8 U# B
13.                 } catch (Exception e) {
    
14.                      e.printStackTrace();
    4 |' E3 H) w/ `6 c! b5 |- P
15.                 }
    ( G  n5 L% i9 I9 E
16. 
    
17.         }

复制代码

admin

我的老家 发表于 2016-11-23 02:55
1 k, ?) X* e3 Y( ?% o有没有发送邮件的功能？

; J+ ]% H  }) a2 o3 B& A4 J% U+ F  U有