【若依分离版操作方法日志与其它业务数据（如入库操作）关联的实现】

比眉伴天荒 2024-03-17 00:04 5阅读 0赞

#### 若依框架业务表和操作日志表关联 ####

*  需求：
 *  分析：
 *  思路：
 *  实现:

## 需求： ##

基于若依分离版框架业务数据与操作日志的数据做个关联

> 入库表

/*入库业务表																															*/
    CREATE TABLE [BS_In](	
    	[Id] 					int IDENTITY(1,1)			NOT NULL,	/*主键Id，采集Id													*/
    	[WhId] 					int				 			NOT NULL,	/*仓库Id															*/
    	[BatchCode] 			[nvarchar](30) 					NULL,	/*批次号															*/
    	[InOrder]		 		[nvarchar](30) 					NULL,	/*入库单据															*/
    	[InType] 				[nvarchar](30)	 			NOT NULL,	/*入库类型															*/
    	[InTime] 				datetime	 				NOT NULL,	/*入库时间															*/
    	[Operator] 				[nvarchar](30) 				NOT NULL,	/*入库人															*/
    	[Notes]	 				[nvarchar](100) 				NULL,	/*备注																*/
    	[LogId]	 				int 						NOT	NULL,	/*操作日志Id														*/
    	 CONSTRAINT [PK_BS_In] PRIMARY KEY CLUSTERED 
    (
    	[Id] ASC
    )WITH (PAD_INDEX  = OFF, STATISTICS_NORECOMPUTE  = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS  = ON, ALLOW_PAGE_LOCKS  = ON) ON [PRIMARY]
    ) ON [PRIMARY];

`其中LogId是取的是操作日志的Id，对应sys_oper_log表的oper_id`

> 操作日志表(若依框架自带)

/*操作日志表																															*/
    CREATE TABLE [sys_oper_log](	
      [oper_id]					bigint  IDENTITY(1,1) NOT NULL,								--日志主键
      [title]					varchar(50) COLLATE Chinese_PRC_CI_AS DEFAULT '' NULL,		--模块标题
      [business_type]			int DEFAULT 0 NULL,											--业务类型（0其它 1新增 2修改 3删除）
      [method]					varchar(100) COLLATE Chinese_PRC_CI_AS DEFAULT '' NULL,		--方法名称
      [request_method]			varchar(10) COLLATE Chinese_PRC_CI_AS DEFAULT '' NULL,		--请求方式
      [operator_type]			int DEFAULT 0 NULL,											--操作类别（0其它 1后台用户 2手机端用户）
      [oper_name]				varchar(50) COLLATE Chinese_PRC_CI_AS DEFAULT '' NULL,		-- 操作人员
      [dept_name]				varchar(50) COLLATE Chinese_PRC_CI_AS DEFAULT '' NULL,		--部门名称
      [oper_url]				varchar(255) COLLATE Chinese_PRC_CI_AS DEFAULT '' NULL,		--请求URL
      [oper_ip]					varchar(128) COLLATE Chinese_PRC_CI_AS DEFAULT '' NULL,		--主机地址
      [oper_location]			varchar(255) COLLATE Chinese_PRC_CI_AS DEFAULT '' NULL,		--操作地点
      [oper_param]				varchar(2000) COLLATE Chinese_PRC_CI_AS DEFAULT '' NULL,	--请求参数
      [json_result]				varchar(2000) COLLATE Chinese_PRC_CI_AS DEFAULT '' NULL,	--返回参数
      [status]					int DEFAULT 0 NULL,											--操作状态（0正常 1异常）
      [error_msg]				varchar(2000) COLLATE Chinese_PRC_CI_AS DEFAULT '' NULL,	--错误消息
      [oper_time]				datetime  NULL,   
    	 CONSTRAINT [PK_sys_oper_log] PRIMARY KEY CLUSTERED 
    (
    	[oper_id] ASC
    )WITH (PAD_INDEX  = OFF, STATISTICS_NORECOMPUTE  = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS  = ON, ALLOW_PAGE_LOCKS  = ON) ON [PRIMARY]
    ) ON [PRIMARY];

`其中oper_id是操作日志的Id，对应BS_In表的logId`  
怎么新建入库任务表同时插入操作日志表再关联插入操作日志表的oper\_id？

## 分析： ##

若依自带的操作日志可以通过@Log注解插入操作日志表  
在需要被记录日志的controller方法上添加@Log注解，使用方法如下：  
![在这里插入图片描述][1297429fcfce47bc9236a7d48f738d7c.png]  
![在这里插入图片描述][b6245273879b4fe3968733f88a529aa1.png]  
其中最核心的是`LogAspect.java`类，它处于`com.ruoyi.framework.aspectj`包下;  
在处理完请求后执行和拦截异常操作后都会执行`handleLog`方法，`handleLog`方法最主要的就是处理  
`SysOperLog`数据库日志对象参数并执行插入数据操作。重点就是这一段代码。![在这里插入图片描述][a668cf342411400d8886d94a954ee3e4.png]

## 思路： ##

*  取出插入日志表`sys_oper_log`表的`oper_id`
 *  将`oper_id`设置到请求上下文或线程局部变量中，以便后续的操作使用
 *  在实现类上新增`@Log`注解，插入入库表`BS_In`，插入成功后取出Id，
 *  在方法中取出`oper_id`和入库表的Id，根据Id去更新`BS_In`的`logId`

## 实现: ##

1.修改`SysOperLogMapper.xml`文件中的`insert`标签的内容，主要修改内容是可以新增后返回`operId`

<insert id="insertOperlog" parameterType="SysOperLog" useGeneratedKeys="true" keyProperty="operId">
    		insert into sys_oper_log(title, business_type, method, request_method, operator_type, oper_name, dept_name, oper_url, oper_ip, oper_location, oper_param, json_result, status, error_msg, oper_time)
            values (#{title}, #{businessType}, #{method}, #{requestMethod}, #{operatorType}, #{operName}, #{deptName}, #{operUrl}, #{operIp}, #{operLocation}, #{operParam}, #{jsonResult}, #{status}, #{errorMsg}, getdate())
    	</insert>

> 加了useGeneratedKeys=“true” keyProperty=“operId”

2.将`oper_id`设置到请求上下文或线程局部变量中,修改`LogAspect.java`类

protected void handleLog(final JoinPoint joinPoint, Log controllerLog, final Exception e, Object jsonResult)
        {
        
            try
            {
        
                // 获取当前的用户
                LoginUser loginUser = SecurityUtils.getLoginUser();
    
                // *========数据库日志=========*//
                SysOperLog operLog = new SysOperLog();
                operLog.setStatus(BusinessStatus.SUCCESS.ordinal());
                // 请求的地址
                String ip = IpUtils.getIpAddr(ServletUtils.getRequest());
                operLog.setOperIp(ip);
                operLog.setOperUrl(ServletUtils.getRequest().getRequestURI());
                if (loginUser != null)
                {
        
                    operLog.setOperName(loginUser.getUsername());
                }
    
                if (e != null)
                {
        
                    operLog.setStatus(BusinessStatus.FAIL.ordinal());
                    operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
                }
                // 设置方法名称
                String className = joinPoint.getTarget().getClass().getName();
                String methodName = joinPoint.getSignature().getName();
                operLog.setMethod(className + "." + methodName + "()");
                // 设置请求方式
                operLog.setRequestMethod(ServletUtils.getRequest().getMethod());
                // 处理设置注解上的参数
                getControllerMethodDescription(joinPoint, controllerLog, operLog, jsonResult);
                // 保存数据库
                operLog.setOperLocation(AddressUtils.getRealAddressByIP(operLog.getOperIp()));
                SpringUtils.getBean(ISysOperLogService.class).insertOperlog(operLog);
                //AsyncManager.me().execute(AsyncFactory.recordOper(operLog));
                RequestContextHolder.currentRequestAttributes().setAttribute("logId", operLog.getOperId(), RequestAttributes.SCOPE_REQUEST);
            }
            catch (Exception exp)
            {
        
                // 记录本地异常日志
                log.error("==前置通知异常==");
                log.error("异常信息:{}", exp.getMessage());
                exp.printStackTrace();
            }
        }

> 修改了保存数据库下代码

3.插入入库业务表，取出新增成功后的主键Id，使用`@Log`主键插入操作日志表

@Log(title = "产品入库", businessType = BusinessType.INSERT)
        @Override
        public int toolin(Map map) throws Exception {
        
            int insertIn = collectMapper.insertIn(in);
            if(insertIn==0) throw new Exception("插入入库业务表失败");
            int MId = Integer.parseInt(in.get("MId").toString());
            return MId;
        }

<insert id="insertIn"  useGeneratedKeys="true" keyProperty="MId">
            insert into BS_In values (#{WhId},#{BatchCode},#{InOrder},#{InType},getdate(),#{Operator},#{Notes},null)
        </insert>

4.取出`MId`和`logId`更新日志

public AjaxResult toolin(@RequestBody Map map){
        
            try {
        
                int MId = collectService.toolin(map);
                Long logId = (Long) RequestContextHolder.currentRequestAttributes().getAttribute("logId", RequestAttributes.SCOPE_REQUEST);
                //执行成功根据主表id更新日志表id
                int i = collectService.updateInLog(MId, logId);
            }catch (Exception e){
        
                return AjaxResult.error(e.getMessage());
            }
            return AjaxResult.success();
        }

<update id="updateInLog">
            update BS_In set LogId=#{logId} where Id=#{MId}
        </update>

效果:  
![在这里插入图片描述][e39f93bc19ad40cda6b5819ab5960bc1.png]  
![在这里插入图片描述][4aceda3c752640d3b481288ec48f1b57.png]  
如果需要查询出关联信息可以使用`inner join`内连接查询

select *
      from BS_In b inner join sys_oper_log s
      on b.LogId=s.oper_id

[1297429fcfce47bc9236a7d48f738d7c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/5b8dba20e7af487ea79771ed109c264e.png
[b6245273879b4fe3968733f88a529aa1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/5104a5bfcf754811afd37df58df44508.png
[a668cf342411400d8886d94a954ee3e4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/bd6fc6ae46b445d0b0878eac2b7b5a61.png
[e39f93bc19ad40cda6b5819ab5960bc1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/d6bd48ec5adc40fea16b1db2c04fbd1c.png
[4aceda3c752640d3b481288ec48f1b57.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/1266f81aed404d529967354f524918ff.png