管理后台操作日志

刘星星star

已于 2023-08-15 19:53:26 修改

阅读量201

点赞数

文章标签： java 开发语言后端

于 2023-08-15 19:48:31 首次发布

本文链接：https://blog.csdn.net/xiaonuniu/article/details/132305873

版权

后台操作日志

一、自定义注解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface TitleName {
    String value() default "";

    int order() default 0;

    boolean primaryKey() default false;
}

二、日志解析工具类

public class WebOperatorLogUtil {
    /**
     * 新增模板
     * 样式:
     * XXX
     * [
     * aa:AA,
     * bb:BB,
     * cc:CC
     * ]
     */
    public static final String ADD_OPERATOR_LOG_TEMPLATE = "{}<br/>[<br/>{}<br/>]";

    /**
     * 修改模板
     * 样式:
     * XXX
     * [
     * aa:AA ==> FF,
     * bb:BB ==> GG,
     * cc:CC ==> HH
     * ]
     */
    public static final String UPDATE_OPERATOR_LOG_TEMPLATE = "{}<br/>[<br/>{}<br/>]";

    /**
     * 删除模板
     * 样式:
     * XXX
     * YY
     * [
     * A,
     * B,
     * C
     * ]
     */
    public static final String DELETE_OPERATOR_LOG_TEMPLATE = "{}<br/>{}<br/>[<br/>{}<br/>]";

    /**
     * 默认模板
     * 样式:
     * XXX
     * YY
     * [
     * aa: AA,
     * bb: BB
     * ]
     */
    public static final String DEFAULT_OPERATOR_LOG_TEMPLATE = "{}<br/>[<br/>{}<br/>]";

    /**
     * 返回新增操作日志
     *
     * @param desc
     * @param obj
     * @return
     */
    public static String getAddContent(String desc, Object obj) {
        Map<Integer, String> tempResultMap = new LinkedHashMap<>();
        String eleTemplate = "&nbsp;&nbsp;{}:&nbsp;&nbsp;{}";

        //1.读取注解上的值
        Field[] fields = ReflectUtil.getFields(obj.getClass());
        for (Field field : fields) {
            TitleName titleName = AnnotationUtil.getAnnotation(field, TitleName.class);
            if (titleName == null) {
                continue;
            }

            tempResultMap.put(titleName.order(), field.getName() + StrUtil.COLON + titleName.value());
        }

        //2.排序
        TreeMap<Integer, String> resultMap = CollUtil.sort(tempResultMap, new Comparator<Integer>() {
            @Override
            public int compare(Integer o1, Integer o2) {
                return o1 - o2;
            }
        });

        //3.拼接数据
        String titleName = "";
        String value = "";
        List<String> result = new ArrayList<>();
        for (Map.Entry<Integer, String> ele : resultMap.entrySet()) {
            String[] dataArray = StrUtil.split(ele.getValue(), StrUtil.COLON);

            titleName = dataArray[1];
            Object fieldValue = ReflectUtil.getFieldValue(obj, dataArray[0]);
            value = fieldValue + "";

            if (fieldValue instanceof Date) {
                value = DateUtil.format(((Date) fieldValue), DatePattern.NORM_DATETIME_PATTERN);
            }

            String eleResult = StrUtil.format(eleTemplate, titleName, value);
            result.add(eleResult);
        }

        return StrUtil.format(ADD_OPERATOR_LOG_TEMPLATE, desc, CollUtil.join(result, "<br/>"));
    }

    /**
     * 返回修改操作日志
     *
     * @param desc
     * @param srcObj
     * @param targetObj
     * @return
     */
    public static String getUpdateContent(String desc, Object srcObj, Object targetObj) {
        Map<Integer, String> tempResultMap = new LinkedHashMap<>();
        String eleTemplate = "&nbsp;&nbsp;{}:&nbsp;&nbsp;{} ==> {}";

        //1.读取注解上的值
        Field[] fields = ReflectUtil.getFields(srcObj.getClass());
        for (Field field : fields) {
            TitleName titleName = AnnotationUtil.getAnnotation(field, TitleName.class);
            if (titleName == null) {
                continue;
            }

            tempResultMap.put(titleName.order(), field.getName() + StrUtil.COLON + titleName.value() + StrUtil.COLON + titleName.primaryKey());
        }

        //2.排序
        TreeMap<Integer, String> resultMap = CollUtil.sort(tempResultMap, new Comparator<Integer>() {
            @Override
            public int compare(Integer o1, Integer o2) {
                return o1 - o2;
            }
        });

        //3.拼接数据
        String titleName = "";
        String srcValue = "";
        String targetValue = "";
        String primaryKey = "false";

        List<String> result = new ArrayList<>();
        for (Map.Entry<Integer, String> ele : resultMap.entrySet()) {
            String[] dataArray = StrUtil.split(ele.getValue(), StrUtil.COLON);

            titleName = dataArray[1];
            primaryKey = dataArray[2];

            Object srcFieldValue = ReflectUtil.getFieldValue(srcObj, dataArray[0]);
            Object targetFieldValue = ReflectUtil.getFieldValue(targetObj, dataArray[0]);

            srcValue = srcFieldValue + "";
            targetValue = targetFieldValue + "";

            //日期进行格式化显示处理
            if (srcFieldValue instanceof Date) {

                srcValue = DateUtil.format(((Date) srcFieldValue), DatePattern.NORM_DATETIME_PATTERN);
                targetValue = DateUtil.format(((Date) targetFieldValue), DatePattern.NORM_DATETIME_PATTERN);
            }

            //增加主键
            if (StrUtil.equals(primaryKey, "true")) {
                String eleResult = StrUtil.format(eleTemplate, titleName, srcValue, targetValue);
                result.add(eleResult);
            }


            //有更新的数据,突出显示
            if (!StrUtil.equals(srcValue, targetValue)) {
                targetValue = "<font color=\"red\">" + targetValue + "</font>";
                String eleResult = StrUtil.format(eleTemplate, titleName, srcValue, targetValue);
                result.add(eleResult);
            }

        }

        return StrUtil.format(UPDATE_OPERATOR_LOG_TEMPLATE, desc, CollUtil.join(result, "<br/>"));
    }

    /**
     * 返回删除日志
     *
     * @param desc
     * @param clazz
     * @param ids
     * @return
     */
    public static String getDeleteContent(String desc, Class clazz, int[] ids) {
        ArrayList<String> tempResult = new ArrayList<>();
        String eleTemplate = "&nbsp;&nbsp;{}";

        for (int id : ids) {
            tempResult.add(StrUtil.format(eleTemplate, id + ""));
        }

        //1.读取注解上的值
        List<String> primaryKeyTitles = new ArrayList<>();
        Field[] fields = ReflectUtil.getFields(clazz);
        for (Field field : fields) {
            TitleName titleName = AnnotationUtil.getAnnotation(field, TitleName.class);
            if (titleName == null) {
                continue;
            }

            if (titleName.primaryKey() == true) {
                primaryKeyTitles.add(titleName.value());
            }
        }


        return StrUtil.format(DELETE_OPERATOR_LOG_TEMPLATE, desc, CollUtil.join(primaryKeyTitles, StrUtil.COMMA), CollUtil.join(tempResult, "<br/>"));
    }

    /**
     * 返回删除日志
     *
     * @param desc
     * @param clazz
     * @param sids
     * @return
     */
    public static String getDeleteContent(String desc, Class clazz, String[] sids) {
        ArrayList<String> tempResult = new ArrayList<>();
        String eleTemplate = "&nbsp;&nbsp;{}";

        for (String id : sids) {
            tempResult.add(StrUtil.format(eleTemplate, id + ""));
        }

        //1.读取注解上的值
        List<String> primaryKeyTitles = new ArrayList<>();
        Field[] fields = ReflectUtil.getFields(clazz);
        for (Field field : fields) {
            TitleName titleName = AnnotationUtil.getAnnotation(field, TitleName.class);
            if (titleName == null) {
                continue;
            }

            if (titleName.primaryKey() == true) {
                primaryKeyTitles.add(titleName.value());
            }
        }


        return StrUtil.format(DELETE_OPERATOR_LOG_TEMPLATE, desc, CollUtil.join(primaryKeyTitles, StrUtil.COMMA), CollUtil.join(tempResult, "<br/>"));
    }

    /**
     * 联合主键返回删除日志
     * @param desc
     * @param clazz
     * @param sids
     * @param splitBit 分割字符
     * @return
     */
    public static String getDeleteContent2(String desc, Class clazz, String[] sids,String splitBit) {
        ArrayList<String> tempResult = new ArrayList<>();
        String eleTemplate = "&nbsp;&nbsp;{}";


        for (String sid : sids) {
            StringBuilder ids = new StringBuilder();
            String[] arr = sid.split(splitBit);
            for (String value : arr) {
                String s = value + StrUtil.COMMA;
                ids.append(s);
            }
            String scoreResult = ids.substring(0, ids.length() - 1);
            tempResult.add(StrUtil.format(eleTemplate, scoreResult + ""));
        }


        //1.读取注解上的值
        List<String> primaryKeyTitles = new ArrayList<>();
        Field[] fields = ReflectUtil.getFields(clazz);
        for (Field field : fields) {
            TitleName titleName = AnnotationUtil.getAnnotation(field, TitleName.class);
            if (titleName == null) {
                continue;
            }

            if (titleName.primaryKey()) {
                primaryKeyTitles.add(titleName.value());
            }
        }


        return StrUtil.format(DELETE_OPERATOR_LOG_TEMPLATE, desc, CollUtil.join(primaryKeyTitles, StrUtil.COMMA), CollUtil.join(tempResult, "<br/>"));
    }

    /**
     * 返回删除日志
     *
     * @param desc
     * @param clazz
     * @param lids
     * @return
     */
    public static String getDeleteContent(String desc, Class clazz, long[] lids) {
        ArrayList<String> tempResult = new ArrayList<>();
        String eleTemplate = "&nbsp;&nbsp;{}";

        for (long id : lids) {
            tempResult.add(StrUtil.format(eleTemplate, id + ""));
        }

        //1.读取注解上的值
        List<String> primaryKeyTitles = new ArrayList<>();
        Field[] fields = ReflectUtil.getFields(clazz);
        for (Field field : fields) {
            TitleName titleName = AnnotationUtil.getAnnotation(field, TitleName.class);
            if (titleName == null) {
                continue;
            }

            if (titleName.primaryKey()) {
                primaryKeyTitles.add(titleName.value());
            }
        }


        return StrUtil.format(DELETE_OPERATOR_LOG_TEMPLATE, desc, CollUtil.join(primaryKeyTitles, StrUtil.COMMA), CollUtil.join(tempResult, "<br/>"));
    }

    /**
     * 返回默认日志
     *
     * @param desc
     * @return
     */
    public static String getDefaultContent(String desc, Object... params) {
        ArrayList<String> content = new ArrayList<>();
        String eleTemplate = "&nbsp;&nbsp;{}";

        for (Object param : params) {
            content.add(StrUtil.format(eleTemplate, param));
        }

        return StrUtil.format(DEFAULT_OPERATOR_LOG_TEMPLATE, desc, CollUtil.join(content, "<br/>"));
    }
}

三、定义切面

/**
 * 系统日志切面
 */
@Aspect
@Component
public class OperatorLogAspect {

    @Resource
    private WebOperatorLogsMapper webOperatorLogsMapper;

    @Autowired
    private HttpServletRequest request;

    @Pointcut("@annotation(higgs.ball.manage.annotation.WebOperationTag)")
    public void logPointCut() {
    }

    /**
     * 环绕通知 @Around
     */
    @Around("logPointCut()")
    public Object around(ProceedingJoinPoint point) throws Throwable {
        Object result = point.proceed();
        try {
            insertLog(point);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return result;
    }

    /**
     * 保存日志
     */
    private void insertLog(ProceedingJoinPoint point) throws UnsupportedEncodingException {
        MethodSignature signature = (MethodSignature) point.getSignature();
        Method method = signature.getMethod();
        BaseController target = (BaseController) point.getTarget();
        WebOperationTag annotation = method.getAnnotation(WebOperationTag.class);
        String operationType = annotation.value().getName();
        // 操作信息
        String operationLog = Arrays.toString(target.getOperationLogArgs());
        String content = operationLog.substring(1, operationLog.length() - 1);
        // 操作内容为空,不记日志
        if (StringUtils.isBlank(content)) {
            return;
        }
        // 操作记录太长截取
        if (content.getBytes("GBK").length > 800) {
            content = this.subStringByByte(content, 800);
        }
        String module = method.getDeclaringClass().getName();
        module = module.substring(module.lastIndexOf(".") + 1, module.lastIndexOf("Controller"));
        // 构造
        WebOperatorLogs log = new WebOperatorLogs();
        log.setLogTime(new Date());
        log.setOperatorType(operationType);
        log.setOperatorModule(module);
        // 身份
        Identity identity = CookieUtil.getIdentityInfo(request);
        log.setOperatorName(identity.getTrueName());
        log.setOperatorId(identity.getUserId());
        log.setContent(content);
        log.setUserName(identity.getUserName());
        webOperatorLogsMapper.add(log);

    }

    /**
     * 按字节截取字符串
     *
     * @param str
     * @param splitByteNum
     * @return
     * @throws UnsupportedEncodingException
     */
    private String subStringByByte(String str, int splitByteNum) throws UnsupportedEncodingException {
        //输入无效判断
        if (StringUtils.isEmpty(str) || splitByteNum <= 0) {
            return "";
        }
        String subStr = str.substring(0, splitByteNum > str.length() ? str.length() : splitByteNum);
        int subStrByteNum = subStr.getBytes("GBK").length;
        int len = splitByteNum;
        while (subStrByteNum > len) {
            int subStrLength = --splitByteNum;
            subStr = str.substring(0, subStrLength > str.length() ? str.length() : subStrLength);
            subStrByteNum = subStr.getBytes("GBK").length;
        }
        return subStr;
    }
}

四、实体类添加注解

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Dict extends ToStringBase {
    private static final long serialVersionUID = -72567329833900420L;

    @TitleName(value = "主键ID",primaryKey = true)
    private long id;

    @TitleName(value = "字典KEY",order = 1)
    private String paramName;

    @TitleName(value = "注释",order = 2)
    private String remark;

    @TitleName(value = "字典值",order = 3)
    private String paramVal;
}