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

admin

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

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

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

一、 记录日志并发送邮件通知
(1)、定义注解：
1.ServiceLog.java(各种参数类型详见上面的资料)
1 H0 u, J3 B; y

1. import java.lang.annotation.*;
   
2. /**
   
3. * 自定义注解 拦截service  
   
4. * 创建者        张志朋
   ( r- B- w& f3 p7 N, E
5. * 创建时间        2015年6月3日
   
6. *
   
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   7 t4 \1 W. p9 f* X
9. @Retention(RetentionPolicy.RUNTIME)   
   # Q1 a8 p$ ^9 m- L. O
10. @Documented   
    
11. public  @interface ServiceLog {
    3 }& `  O& Y9 ~7 C
12.          String description()  default "";
    
13. }

复制代码

2.ControllerLog.java
$ A/ w9 o; u) y. X5 @1 O8 G' K

1. import java.lang.annotation.*;
   
2. /**
   
3. * 自定义注解 拦截Controller
   ) |1 b# V. s1 h% O
4. * 创建者        张志朋
   
5. * 创建时间        2015年6月3日
   # h6 t2 N8 p9 ]
6. *
   + w; C/ p# Y: z, O/ L5 e6 x4 E1 x
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   * R  h/ G# \/ k# w3 C7 J9 V
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented
    
11. public @interface ControllerLog {
    - G. n3 q: P  U1 M$ m" C0 z
12.         String description()  default "";
    
13. }

复制代码

(2)、定义切面以及切入点
) r! V+ I' k$ S: e1.LogAspect.java

1. /**
   
2. * 日志记录AOP
   
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月3日
   $ O/ D8 o) R) Z6 x" f
5. *
   
6. */
   / a1 U+ `/ Y& K9 ^& A$ u
7. @Component
   1 j  j0 H1 E, X( ~. }
8. @Scope
   . y5 b. y7 k3 X) u
9. @Aspect
   # T, R1 b: g; _7 q, J
10. public class LogAspect {
    0 f) \$ m# r& b  B4 q3 N8 t& s
11.         //Service层切点     用于记录错误日志
    2 R. m$ _9 V9 g. e$ _: T& G
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    ! L1 K) e; Z- x! b0 w1 W3 G
13.         public void serviceAspect() {
    
14.                
    
15.         }
    
16.     /**
    
17.      * 异常通知 用于拦截service层记录异常日志  
    ! [% K" }, o  Q% F# x$ r* r5 R
18.      * @Author        张志朋
    % Y# k: p# e- B' Y% N. S
19.      * @param joinPoint
    
20.      * @param e  void
    6 n. R5 B* b) _
21.      * @Date        2015年6月3日
    
22.      * 更新日志
    
23.      * 2015年6月3日 张志朋  首次创建
    # P" ~7 I8 V$ a2 h2 J8 X
24.      *
    
25.      */
    ! l. ]- L- ?& C# C! Q/ Y
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    ; B1 U; Q2 y  g
29.                 TeacherEntity user = CommonUtil.getUser();
    3 C% B4 [- ?9 P
30.                 String ip = AddressUtils.getIpAddr(request);
    
31.                 try {
    
32.                         String params = "";
    # _7 d* F0 S( u5 t- x/ [$ }
33.                         if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
    
34.                                 for (int i = 0; i < joinPoint.getArgs().length; i++) {
    8 T( s, Y' h% }' S9 C
35.                                         params += JSONUtil.toJSONstring(joinPoint.getArgs()[i]) + ";";
    
36.                                 }
    
37.                         }
    
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
    
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    % N3 q3 n; d" X( |) P/ ~
40.                         String exceptionDetail = e.getMessage();//异常详细信息
    8 W1 Q* v+ p) `' r  ~) V) }
41.                         String method = joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()";//异常方法
    $ F$ d6 J) I2 N$ Q9 Y$ W+ F
42.                         /*==========记录数据库异常日志==========*/  
    5 E+ l. B- M0 o' U  B
43.                         Log log = new Log();
    . S% ~& V. U- F1 m9 T. d
44.                         log.setDescription(description);
    
45.                         log.setExceptionCode(exceptionCode);
    * Z# q  n; o& P% f9 v
46.                         log.setExceptionDetail(exceptionDetail);
    ( E' Q! X7 }# m+ J- g2 c
47.                         log.setMethod(method);
    
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    
49.                         log.setRequestIp(ip);// 请求IP
    # Q8 H$ y2 H  s7 V5 n) T6 G$ H
50.                         log.setParams(params);//请求参数
    
51.                         if(null!=user){
    
52.                     log.setCreateUid(user.getUid());//用户ID
    
53.                     log.setCreateName(user.getNickname());//用户昵称
    
54.             }
    1 s. {6 v$ C+ K# |$ b
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    9 ]& B9 }* ]& ~1 a( s5 G
56.                         /*==========记录数本地异常日志==========*/  
    
57.                         //LogUtil.error(description, e);
    3 Y. d: p* h& G2 h
58.                         /*==========发送异常日志到邮箱==========*/
    
59.                         StringBuffer errorMsg = new StringBuffer();
    
60.                         errorMsg.append("异常方法:");
    . o& c0 V! Z( _0 o: t
61.                         errorMsg.append(method);
    ! l. f5 H8 [. m' Y* i
62.                         errorMsg.append("</br>");
    ( H% {) z( V6 S& p- v  T
63.                         errorMsg.append("异常类型代码:");
    1 `  X4 w4 E2 f" n2 k4 Z0 N- {6 V+ _
64.                         errorMsg.append(exceptionCode);
    
65.                         errorMsg.append("</br>");
    
66.                         errorMsg.append("异常详细信息:");
    
67.                         errorMsg.append(exceptionDetail);
    4 X1 F1 ~, |  E7 e
68.                         errorMsg.append("</br>");
    
69.                         log.setErrorMsg(errorMsg.toString());
    
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    
71.                         Client.sendError(log);
    8 [1 [) N7 E; b# a( l7 _
72.                 } catch (Exception ex) {
    5 E9 Z/ h5 B" d  j
73.                         e.printStackTrace();
    
74.                 }
    2 N, `* [% R5 D+ X1 J% q. n  z7 n
75.     }
    3 o0 K" l& O/ a9 v. [# v
76.      /**
      `% B* C7 ]" ?" Z
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    ' }- w6 o- H+ P. {, _) g& A, t
78.       * @Author        张志朋
    7 F! F( ?$ c0 g4 D" ]
79.       * @param joinPoint
    $ {) w1 f3 F6 L
80.       * @return
    * {; |/ Y: `( ^; P$ S: m( i9 y
81.       * @throws Exception  String
    
82.       * @Date        2015年6月3日
    , H$ M8 d9 B6 y: a
83.       * 更新日志
    0 j& w0 n7 w7 o! F; h7 ]) `
84.       * 2015年6月3日 张志朋  首次创建
    
85.       *
    ) w. u7 s+ L8 W4 {1 }
86.       */
    
87.      @SuppressWarnings("rawtypes")
    6 R3 r# S: ?- J- @- c& q  I
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    4 y8 Q: Q& R5 Z9 d3 j7 |  i
89.              throws Exception {   
    
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    0 w* M9 X+ q8 F
91.         String methodName = joinPoint.getSignature().getName();   
    + N; n' V0 t* j5 q" W  m
92.         Object[] arguments = joinPoint.getArgs();   
    
93.         Class targetClass = Class.forName(targetName);   
    
94.         Method[] methods = targetClass.getMethods();   
    
95.         String description = "";   
    * y9 k9 h7 v2 c5 {5 T) \( N" E
96.          for (Method method : methods) {   
    
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;   
     + |: t8 p; z3 R7 N( S
102.                 }   
     ( M* Z3 g& W- o' D
103.             }   
     * M& d* K+ |' H4 _# f* i
104.         }   
     ( n& B$ ^: m$ L  I0 |) n
105.          return description;   
     
106.     }
     ) E0 H) K0 h- \$ F, ~
107.     }

复制代码

这里说明一下  serviceAspect()方法 上面注释了 @Pointcut("@annotation(com.acts.web.aop.ServiceLog)")  、也就说明这是一个切入点，springAOP对其进行了封装。
doAfterThrowing()方法上面加入了@AfterThrowing(pointcut = "serviceAspect()", throwing = "e") 对切入点的所有异常信息进行处理(记录日志到数据库或者发送错误信息到指定邮箱等等等，可以做任何你想做的事情)。
- Q/ D0 J+ n- n) M# A
4 r4 t# G* P! Z: p5 r3 P" ?2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）
% X9 Q' @0 S/ T7 ~2 D3 R3 M

1. @ServiceLog(description="获取待审试题数量")
   - l/ z' h$ q2 I3 A
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   : g* P$ y+ b4 m( p2 ~1 Z
3.                 return quesPerDao.getAuditQuesNum(currentUser);
   % Y7 e! T  [1 e6 o& Z/ q# ]
4.         }

复制代码

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

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

复制代码

(1)、定义注释：
! [8 s: \; Q) F* e( ^! V; j- U( l1.Permission.java

1. /**
   
2. * 自定义权限管理
   * N/ n2 B9 X. J+ z1 I7 T
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月30日
   
5. *
   
6. */
   + O4 N) m2 K: @8 ?9 P
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   2 r. ]( I7 ]4 }8 r. J
8. @Retention(RetentionPolicy.RUNTIME)   
   ) v: m& A5 ?! ?
9. @Documented
   
10. public @interface Permission {
    
11.         String name()  default ""; //操作行为
    & P1 {9 e: n. @
12.         int id() default -1;//权限值
    : b' I7 U2 H7 `7 o/ W! s+ I
13. }

复制代码

(2)、定义切面以及切入点
1.PsemissionAspect.java
6 U* G' A/ O4 l/ r( Y: B& g; A

1. /**
   
2. * 权限管理
   ! y; C( Z) U5 }6 n4 ^8 g  f
3. * 创建者        张志朋
   1 k) Z8 ^! G' D1 ^2 W7 M0 c7 s
4. * 创建时间        2015年7月3日
   6 {, ?: u5 `5 P/ K! W5 [# ^; Q
5. *
   8 v7 r) a8 z7 x$ s! m
6. */
   
7. @Component
   5 n$ p! f1 T4 a( }2 I
8. @Scope
   
9. @Aspect
   1 ~1 @" g8 R' X. W* E7 S2 _5 t
10. public class PsemissionAspect {
    / a/ f+ O( \1 y
11.         
    
12.     //Controller层切点 用于权限控制
    
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
    & O) w7 {8 [( |# Y( ?$ t
14.         public void permissionAspect() {
    
15.                
    
16.         }
    % y( I4 \4 |- i3 K# L0 F- d
17.         /**
    
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    & T! x6 G  N7 y
19.          * @Author        张志朋
    6 P* }  C' e& k6 S0 y
20.          * @param joinPoint  void
    0 V" z5 s3 |( R  i1 Y) F
21.          * @Date        2015年6月3日
    7 d5 J$ U8 O  N" W
22.          * 更新日志
    7 k% J. |+ Y3 C- j3 X
23.          * 2015年6月3日 张志朋  首次创建
    
24.          *
    8 e* X6 ~; R1 D* b; }* {
25.          */
    
26.     @Around("permissionAspect()")   
    
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    
28.         Object retVal = null;
    0 Q" h2 F" s7 E" e5 m% T. {
29.                 int role  =  getControllerMethodRole(joinPoint);
    5 K  b+ W% I# C- A+ v; f, f; l7 @
30.                 TeacherEntity user = CommonUtil.getUser();
    
31.                 if((user.getSpecRole()&role)==role){//没有权限
      _2 R% O% T& A1 q: a# y! D) h
32.                         retVal  = joinPoint.proceed();
    
33.                 }else{
    & L# Y, \1 v- T. v( ?2 S
34.                         noAuthorization();
    
35.                 }
    ( I+ ^8 H2 Z& {+ p* [; [
36.             return retVal;
    
37.     }
    . @& ~) q0 K' ]7 }) \% B
38.     /**
    
39.      * 没有权限 实现跳转
    
40.      * @Author        张志朋
    
41.      * @throws IOException  void
    0 |% G/ {! D# P
42.      * @Date        2015年7月3日
    - o  f( e6 Q- [: ^% i+ ~
43.      * 更新日志
    . A5 _/ h1 H7 E; S& \
44.      * 2015年7月3日 张志朋  首次创建
    
45.      *
    ( ]/ H+ {* {, E9 E0 V& b% `
46.      */
    
47.     public void noAuthorization() throws IOException{
    
48.             HttpServletRequest request = ServletActionContext.getRequest();
    
49.                 String path =  request.getContextPath();
    
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
    ' s3 R, i- e/ z* I
52.     }
    4 n% q1 J% V6 S7 O4 {) `
53.     /**
    
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    
55.      * @Author        张志朋
    
56.      * @param joinPoint
    7 x# o) A4 O. F+ c2 j- T9 }8 ~( B9 s
57.      * @return
    5 R- O8 Q1 h: J7 J
58.      * @throws Exception  int
    
59.      * @Date        2015年7月3日
    
60.      * 更新日志
    
61.      * 2015年7月3日 张志朋  首次创建
    ; y3 r9 \9 l5 ?% I' J( q! ?
62.      *
    
63.      */
    6 L# a* Z4 b# X
64.     @SuppressWarnings("rawtypes")
    
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    ' M8 x/ k1 K: I+ c& v3 l
67.         String methodName = joinPoint.getSignature().getName();   
    
68.         Object[] arguments = joinPoint.getArgs();   
    
69.         Class targetClass = Class.forName(targetName);   
    . b  p: C/ i: l3 {' ]* u$ q- h$ e5 L
70.         Method[] methods = targetClass.getMethods();   
    ! L0 Y+ e9 K/ G
71.         int role = -1;   
    % W) y& m5 C4 p
72.          for (Method method : methods) {   
    
73.              if (method.getName().equals(methodName)) {   
    
74.                 Class[] clazzs = method.getParameterTypes();   
    9 |) K' @. c" V8 H% h1 s
75.                  if (clazzs.length == arguments.length) {   
    . d! n) y: Y% J( p! ?" f+ c9 r' b2 W
76.                          role = method.getAnnotation(Permission. class).id();   
    0 E. g7 C/ o/ _+ j
77.                      break;   
    
78.                 }   
    
79.             }   
    / t  k$ |5 k+ I& B6 f
80.         }   
    4 |, Q9 c/ ^6 ]
81.          return role;   
    
82.     }

复制代码

2 z  r. S: v: O" A& Z  H: N2.action层代码实现：
2 B) F9 n9 J7 @: S" [$ k% L4 a% v

1. /**
   
2.          * 试题审核不通过
   
3.          * @Author        张志朋  void
   
4.          * @Date        2015年5月4日
   # F7 J* `+ e! Q# H; |4 c# _& ^( A
5.          * 更新日志
   
6.          * 2015年5月4日 张志朋  首次创建
   - h0 G, `+ T' y5 }3 j6 t8 B
7.          *
   . W) J: M) F- ?- k7 h2 ?5 a% x
8.          */
   5 g' ~8 m4 X* N+ Q
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   
10.         public void auditQuestions(){
    0 Y" W( a6 F$ [0 l9 e
11.                 try {
    
12.                      //代码实现
    
13.                 } catch (Exception e) {
    + z- @9 n" M  ]% e% }. \
14.                      e.printStackTrace();
    
15.                 }
    + h; R& k% t1 E- m
16. 
    4 a. n) s: w5 g- _
17.         }

复制代码

! e  E1 ~7 O$ d& t
) B: l. v1 u' T( K: `

zcl001001

学习学习，参考下开发

zrszrs

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

奈何、

学习学习。

劉様

不错不错

花生壳

花生壳到此一逛

春天

好东西            谢谢分享

辉大大

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

我的老家

admin 发表于 2016-11-23 13:24
0 K  `2 \" V' N4 C4 m有

! a' d; t% G8 E$ t好的 谢谢了  麻烦你了

淡定240

不错，受用了，谢谢分享

admin

我的老家 发表于 2016-11-23 02:55
. H% x$ Z1 }0 x2 i- @, Y有没有发送邮件的功能？

有