Spring_AOP 记录系统关键操作日志用法
问题:
系统需要记录用户的关键操作日志,以便后期的系统维护,方便的查看问题,及时排除
分析:
(1)保存字段:作为一个日志记录功能,首先数据库新建一张表保存用户的操作关键字段,
用户名,ip,操作描述,时间,日志id
(2)采用技术:
第一种:新建一个日志业务实现,在操作发生时进行联动
缺点是耦合太紧密,无用代码增多,后期代码臃肿,改动时地方分散,不利于维护
第二种:使用spring 的 aop 技术进行切面切入
由于本身系统结构不规范,参数,方法名没有一致的样式,使用正则匹配方法名不是很方便
本身日志记录也只是记录关键操作,api全部切入的话,就不需要这个功能了
必须有针对性的记录关键操作日志
第三种:使用spring 的 aop 技术切到自定义注解上,针对不同注解标志进行参数解析,记录日志
缺点是要针对每个不同的注解标志进行分别取注解标志,获取参数进行日志记录输出
解决:
由于本身系统的不规范,个人技术能力的欠缺,目前采用第三种办法进行关键日志的记录
(1)首先新建 注解类【MethodLog】
package org.triber.portal.service.logAop; import java.lang.annotation.*; /**
* 日志切面注解
*/ @Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MethodLog { String remark() default "";
String operType() default "0";
// String desc() default "";
}
(2)新建切面实现类【LogService】
package org.triber.portal.service.logAop; import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.triber.common.helper.StringUtil;
import org.triber.common.helper.UserUtil;
import org.triber.common.model.menu.MenuModel;
import org.triber.common.model.user.User;
import org.triber.portal.dao.mapper.operateLog.OperateLogMapper;
import org.triber.portal.model.area.Area; import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.text.SimpleDateFormat;
import java.util.Calendar; /**
* 日志切面实现
*/ @Component
@Aspect
public class LogService { @Autowired
private OperateLogMapper dao; public LogService() {
System.out.println("Aop");
} /**
* 切点
*/
@Pointcut("@annotation(org.triber.portal.service.logAop.MethodLog)")
public void methodCachePointcut() { } /**
* 切面
*
* @param point
* @return
* @throws Throwable
*/
@Around("methodCachePointcut()")
public Object around(ProceedingJoinPoint point) throws Throwable { HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder
.getRequestAttributes()).getRequest();
SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss E");
Calendar ca = Calendar.getInstance();
String operDate = df.format(ca.getTime());
String ip = getIp(request);
User user = UserUtil.getCurrentUser(request);
String loginName;
String name;
if (user != null) {
loginName = user.getLoginName();
} else {
loginName = "匿名用户";
}
String methodRemark = getMthodRemark(point);
String methodName = point.getSignature().getName();
String packages = point.getThis().getClass().getName();
if (packages.indexOf("$$EnhancerByCGLIB$$") > -1) { // 如果是CGLIB动态生成的类
try {
packages = packages.substring(0, packages.indexOf("$$"));
} catch (Exception ex) {
ex.printStackTrace();
}
}
String operatingcontent = "";
Object[] method_param = null; Object object;
try {
method_param = point.getArgs(); //获取方法参数
// String param=(String) point.proceed(point.getArgs());
object = point.proceed();
} catch (Exception e) {
// 异常处理记录日志..log.error(e);
throw e;
}
Syslog sysLog = new Syslog();
sysLog.setOptId(org.triber.common.util.StringUtil.getRandNum(11));
sysLog.setLoginId(user.getLoginId());
sysLog.setLoginName(loginName);
sysLog.setIpAddress(ip);
sysLog.setMethodName(packages + "." + methodName);
sysLog.setMethodRemark(methodRemark);
sysLog.setOptDate(operDate); /**
* 用户操作
*/
if("新增用户".equals(methodRemark)){
HttpServletRequest req = (HttpServletRequest) method_param[0];
sysLog.setOperatingcontent("新增用户: 用户名为 " + req.getParameter("userName")); }
if("删除用户".equals(methodRemark)){
String loginId = (String) method_param[1];
sysLog.setOperatingcontent("删除用户: 用户id为 " + loginId);
}
if("修改用户".equals(methodRemark)){
HttpServletRequest req = (HttpServletRequest) method_param[0];
sysLog.setOperatingcontent("修改用户: 用户名为 " + req.getParameter("loginName"));
} /**
* 角色操作
*/
if("新增角色".equals(methodRemark)){
HttpServletRequest req = (HttpServletRequest) method_param[0];
sysLog.setOperatingcontent("新增角色: 角色名为 " + req.getParameter("roleDesc"));
}
if("删除角色".equals(methodRemark)){
String roleId = (String) method_param[1];
sysLog.setOperatingcontent("新增角色: 角色id为 " + roleId);
}
if("修改角色".equals(methodRemark)){
HttpServletRequest req = (HttpServletRequest) method_param[0];
sysLog.setOperatingcontent("修改角色: 角色名为 " + req.getParameter("roleDesc"));
} /**
* 菜单操作
*/
if("新增菜单".equals(methodRemark)){
MenuModel menuModel = (MenuModel) method_param[0];
sysLog.setOperatingcontent("新增菜单: 菜单名为 " + menuModel.getMenuName());
}
if("删除菜单".equals(methodRemark)){
String menuId = (String) method_param[0];
sysLog.setOperatingcontent("删除菜单: 菜单id为 " + menuId);
}
if("修改菜单".equals(methodRemark)){
MenuModel menuModel = (MenuModel) method_param[0];
sysLog.setOperatingcontent("修改菜单: 菜单名为 " + menuModel.getMenuName());
} /**
* 部门操作
*/
if("新增部门".equals(methodRemark)){
String deptDesc = (String) method_param[1];
sysLog.setOperatingcontent("新增部门: 部门名为 " + deptDesc); }
if("修改部门".equals(methodRemark)){
String deptDesc = (String) method_param[2];
sysLog.setOperatingcontent("修改部门: 部门名为 " + deptDesc);
} /**
* 地区操作
*/
if("新增地区".equals(methodRemark)){
Area area = (Area) method_param[0];
sysLog.setOperatingcontent("新增地区: 地区名为 " + area.getAreaDscr().trim());
}
if("删除地区".equals(methodRemark)){
String areaId = (String) method_param[0];
sysLog.setOperatingcontent("删除地区: 地区id为 " + areaId);
}
if("修改地区".equals(methodRemark)){
Area area = (Area) method_param[0];
sysLog.setOperatingcontent("修改地区: 地区名为 " + area.getAreaDscr().trim());
} /**
* 机构操作
*/
if("新增机构".equals(methodRemark)){
String isAdd = (String) method_param[1];
if(isAdd.equals("1")){
String addOrgDscrPancy = (String) method_param[5];
sysLog.setOperatingcontent("新增机构: 机构名为 " + addOrgDscrPancy);
}else{
String addOrgDscrPancy = (String) method_param[5];
sysLog.setOperatingcontent("修改机构: 机构名为 " + addOrgDscrPancy);
} }
if("删除机构".equals(methodRemark)){
String orgId = (String) method_param[3];
sysLog.setOperatingcontent("删除机构: 机构id为 " + orgId);
} /**
* 空参数
*/
if("".equals(methodRemark) || null == methodRemark){
sysLog.setOperatingcontent("操作参数: " + method_param[0]);
} dao.saveSysLog(sysLog);
// System.out.println("日志实体:"+sysLog.getLoginName()+sysLog.getMethodRemark()+sysLog.getOperatingcontent());
return object; } /**
* 方法异常时调用
*
* @param ex
*/
public void afterThrowing(Exception ex) {
System.out.println("afterThrowing");
System.out.println(ex);
} /**
* 获取方法中的中文备注
*
* @param joinPoint
* @return
* @throws Exception
*/
public static String getMthodRemark(ProceedingJoinPoint joinPoint) throws Exception { String targetName = joinPoint.getTarget().getClass().getName();
String methodName = joinPoint.getSignature().getName();
Object[] arguments = joinPoint.getArgs(); Class targetClass = Class.forName(targetName);
Method[] method = targetClass.getMethods();
String methode = "";
for (Method m : method) {
if (m.getName().equals(methodName)) {
Class[] tmpCs = m.getParameterTypes();
if (tmpCs.length == arguments.length) {
MethodLog methodCache = m.getAnnotation(MethodLog.class);
if (methodCache != null) {
methode = methodCache.remark();
}
break;
}
}
}
return methode;
} /**
* 获取请求ip
*
* @param request
* @return
*/
public static String getIp(HttpServletRequest request) {
String ip = request.getHeader("X-Forwarded-For");
if (StringUtil.isNotEmpty(ip) && !"unKnown".equalsIgnoreCase(ip)) {
int index = ip.indexOf(",");
if (index != -1) {
return ip.equals("0:0:0:0:0:0:0:1")?"127.0.0.1":ip.substring(0, index);
} else {
return ip.equals("0:0:0:0:0:0:0:1")?"127.0.0.1":ip;
}
}
ip = request.getHeader("X-Real-IP");
if (StringUtil.isNotEmpty(ip) && !"unKnown".equalsIgnoreCase(ip)) {
return ip;
}
return request.getRemoteAddr().equals("0:0:0:0:0:0:0:1")?"127.0.0.1":ip;
} }
(3)新建日志实体【Syslog】
package org.triber.portal.service.logAop; import lombok.Getter;
import lombok.Setter; import java.io.Serializable; /**
* 操作日志实体类
*/
public class Syslog implements Serializable{ @Setter@Getter private String optId;
@Setter@Getter private String loginId;
@Setter@Getter private String loginName;
@Setter@Getter private String ipAddress;
@Setter@Getter private String methodName;
@Setter@Getter private String methodRemark;
@Setter@Getter private String operatingcontent;
@Setter@Getter private String optDate;
//模糊条件
@Setter@Getter private String serchCondition;
}
(4)日志切入【添加注解标志即可】
/**
* 删除金融机构
* @param request
* @param response
* @param operateVersionId 机构版本
* @param orgId 机构iD
* @param orgLvl 机构层级
* @return
* @throws Exception
*/
@RequestMapping(value = "delOrgByFlagAndOrgId", method = RequestMethod.POST, produces = {"application/json"})
@MethodLog(remark = "删除机构")
public String delOrgByFlagAndOrgId(HttpServletRequest request,
HttpServletResponse response,
@RequestParam(value = "operateVersionId", required = false) String operateVersionId,
@RequestParam(value = "orgId", required = false) String orgId,
@RequestParam(value = "orgLvl", required = false) String orgLvl) throws Exception{
orgService.delOrgByFlagAndOrgId(areaIdPrefix,orgId, orgLvl, operateVersionId);
return "0";
}
(5)maven注入aop依赖
<!--spring切面aop依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency> 在application.properties文件里加这样一条配置
spring.aop.auto=true 在springboot项目里加这两条配置即可,就可以开启aop功能
总结:
至此,大功告成,可以开始加注解标志,获取参数,记录关键信息,输出日志了。。。
Spring_AOP 记录系统关键操作日志用法的更多相关文章
- Struts2拦截器记录系统操作日志
前言 最近开发了一个项目,由于项目在整个开发过程中处于赶时间状态(每个项目都差不多如此)所以项目在收尾阶段发现缺少记录系统日志功能,以前系统都是直接写在每个模块的代码中,然后存入表单,在页面可以查看部 ...
- 【开源】OSharp3.0框架解说系列(6.2):操作日志与数据日志
OSharp是什么? OSharp是个快速开发框架,但不是一个大而全的包罗万象的框架,严格的说,OSharp中什么都没有实现.与其他大而全的框架最大的不同点,就是OSharp只做抽象封装,不做实现.依 ...
- linux查看ssh用户登录日志与操作日志
linux查看ssh用户登录日志与操作日志 2013-11-01转载 ssh用户登录日志 linux下登录日志在下面的目录里: 代码如下 复制代码 cd /var/log 查看ssh用户的登录日 ...
- Winform开发框架之权限管理系统改进的经验总结(4)-一行代码实现表操作日志记录
在前面介绍了几篇关于我的权限系统改进的一些经验总结,本篇继续这一系列主体,介绍如何一行代码实现重要表的操作日志记录.我们知道,在很多业务系统里面,数据是很敏感的,特别对于一些增加.修改.删除等关键的操 ...
- 微软企业库5.0 学习之路——第九步、使用PolicyInjection模块进行AOP—PART4——建立自定义Call Handler实现用户操作日志记录
在前面的Part3中, 我介绍Policy Injection模块中内置的Call Handler的使用方法,今天则继续介绍Call Handler——Custom Call Handler,通过建立 ...
- Jeecg中通过Spring_AOP+注解方式实现日志的管理
转载;https://blog.csdn.net/ma451152002/article/details/77234236 Jeecg中通过Spring_AOP+注解方式实现日志的管理 一.设计思路 ...
- [从源码学设计]蚂蚁金服SOFARegistry 之 服务注册和操作日志
[从源码学设计]蚂蚁金服SOFARegistry之服务注册和操作日志 目录 [从源码学设计]蚂蚁金服SOFARegistry之服务注册和操作日志 0x00 摘要 0x01 整体业务流程 1.1 服务注 ...
- Appfuse:记录操作日志
appfuse的数据维护操作都发生在***form页面,与之对应的是***FormController,在Controller中处理数据的操作是onSubmit方法,既然所有的操作都通过onSubmi ...
- C#操作日志
首先引用NLog的dll文件 using System.IO; using NLog; -------------------------------------------------------- ...
随机推荐
- 自定义View类
一.如何创建自定义的View类 ①.创建一个继承android.view.View类的Java类,并且重写构造方法(至少需要重写一个构造方法) ②.根据需要重写其他方法 ③.在项目的活动中,创建并实例 ...
- 性能优化4--Bitmap内存优化
1.Bitmap在Android虚拟机中的内存分配 在Android3.0之前,Bitmap的内存分配分为两部分,一部分是分配在Dalvik的VM堆中.而像素数据的内存是分配在Native堆中,而到了 ...
- 从头开始:详解MVVM、MVVMLight
究竟为什么要学习MVVM? 相信大部分同学在刚开始接触MVVM的时候(包括我自己),心里默默在想这究竟是什么玩意?一个简单的功能要写一大段代码才能完成,在看到MVVM的核心目标: 1.让UI界面与逻辑 ...
- 使用VSTS的Git进行版本控制(四)——在Visual Studio中管理分支
使用VSTS的Git进行版本控制(四)--在Visual Studio中管理分支 可以从web版Team Services Git repo 的Branches视图中管理工作.定制视图来跟踪最关注的分 ...
- telnet 测试网站是否开启长连接
测试服务器是否开启keepalive(长连接) telnet 主机名(域名|IP) 80 #发起请求GET /index.html HTTP/1.1Host: www.cbnsc.com 如果请求完后 ...
- cmd输出控制台传递的参数
public class Test2{ public static void main(String[] args){ System.out.println(args[0]); System.out. ...
- 洗礼灵魂,修炼python(78)--全栈项目实战篇(6)—— 多级目录菜单之地址管理系统
相信各位都在在网上买过东西吧?那么今天我的主题就是写个在线购物系统,是不可能的,哈哈(后期确实有这个项目),那么购物都填写过快递地址吧?然后网上查个地址都有地址管理吧? 要求: 1.打印出省.市.县等 ...
- Sublime Text 2 配置PHP调试环境(在windows环境下)
1:PHP安装,配置环境变量 PHP安装略过- 2:下载Sublime Text 2 下载地址:http://www.sublimetext.com/2 ,选择自己合适的版本 3:点击 sublime ...
- 日志收集(ElasticSearch)串联查询 MDC
之前写过将应用程序或服务程序产生的日志直接写入搜索引擎的博客 其中基本过程就是 app->redis->logstash->elasticsearch 整个链路过程 本来想将re ...
- Go学习笔记06-内建容器
Go学习笔记06-内建容器 Go语言 数组 *切片(Slice) #F44336 Slice的操作 Map map示例 字符处理 数组 定义数组: //这样定义数组编译器自动初始化每个元素为0 va ...