Grace:优雅高效的的记录业务操作日志

Grace[ɡreɪs]是一款业务操作日志记录框架,让我们使用更优雅方式来记录有效的、可读性高的操作日志。

项目地址

快速集成

Grace提供了grace-bom依赖,定义了全部依赖的统一版本。

Maven项目在pom.xml文件内添加依赖如下所示:

<dependencies>
        <dependency>
            <groupId>org.minbox.framework</groupId>
            <artifactId>grace-expression</artifactId>
        </dependency>
        <dependency>
            <groupId>org.minbox.framework</groupId>
            <artifactId>grace-core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.minbox.framework</groupId>
            <artifactId>grace-processor</artifactId>
        </dependency>
    </dependencies>
<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.minbox.framework</groupId>
                <artifactId>grace-bom</artifactId>
                <version>{lastVersion}</version>
                <scope>import</scope>
                <type>pom</type>
            </dependency>
        </dependencies>
    </dependencyManagement>

{lastVersion}为最新的版本号,可到Maven中央仓库查看最新版本 https://search.maven.org/search?q=grace-bom

记录日志

记录日志主要是依靠@GraceRecorder注解来配置,该注解只能在方法上使用。

@GraceRecorder注解的属性定义如下所示:

  • success:目标方法成功执行后所使用的日志模板,支持使用SpEL表达式方式配置
  • fail:目标方法执行失败后所使用的文本
  • condition:判定是否执行记录操作日志,支持使用SpEL表达式方式配置
  • bizNo:业务编号,支持使用SpEL表达式方式配置
  • operator:操作日志所关联的操作人,支持使用SpEL表达式方式配置
  • category:日志分组,可用于对操作日志进行归类

注意:SpEL表达式使用模板定义前后缀的方式,只有在{}内的字符串才会被解析。

@RestController
public class TestController {
    @Autowired
    private TestService testService;

    @GetMapping
    @GraceRecorder(success = "用户:{#name},编号:{#userId} 访问了首页.", category = "index")
    public String index(String name, String userId) {
        name = testService.getUserName(userId);
        testService.getUserList(userId);
        return "Hello, " + name;
    }
}

保存日志

操作日志根据AOP切面解析完成后会调用org.minbox.framework.grace.processor.GraceLogStorageProcessor#storage方法进行后续的数据存储处理,

需要实现GraceLogStorageProcessor接口来自定义进行日志的存储。

@Service
@Slf4j
public class GraceLogStorageProcessorService implements GraceLogStorageProcessor {
    @Override
    public void storage(GraceLogObject graceLogObject) {
        log.info("位置:{},日志内容:{}", graceLogObject.getGeneratedLocation(), graceLogObject.getContent());
    }
}

配置全局操作人

如果项目中使用了认证框架,比如:SpringSecurityOAuth2,一般会线程安全的存储登录人的相关信息,如果我们再在@GraceRecorder注解内重复配置operator就显得太过于繁琐。

针对这种情况Grace提供了全局配置操作人的接口GraceLoadOperatorService,我们只需要实现该接口即可,优先级要低于@GraceRecorder#operator

@Service
public class GlobalOperatorService implements GraceLoadOperatorService {
    @Override
    public String getOperatorName() {
        return "恒宇少年";
    }

    @Override
    public String getOperatorId() {
        return "123";
    }

    @Override
    public Map<String, Object> getExtra() {
        Map<String, Object> map = new HashMap<>();
        map.put("age", 11);
        return map;
    }
}

getExtra方法的返回值会写入到表达式解析上下文变量集合内,可以用于SpEL表达式的解析变量。

使用参数

方法参数是格式化SpEL表达式数据的重要来源,可以使用方法的全部参数作为格式化日志的变量。

基本类型(byte/short/int/long/String)的使用:

@GraceRecorder(category = "User", success = "用户:{#userId} 密码更新完成,更新后的密码:{#newPassword}.")
public void changePwd(String userId, String newPassword) {
  // ...
}

封装类型使用:

@GraceRecorder(category = "User", success = "用户:{#request.userId} 密码更新完成,更新后的密码:{#request.newPassword}.")
public void changePwd(ChangeUserPwdRequest request){
  // ...
}

Map类型使用:

请求参数:http://127.0.0.1:8080/changePassword?userId=123456&newPassword=111111

@GetMapping("/changePassword")
@GraceRecorder(category = "Test", success = "修改用户:{#map.get('userId')}的密码,改后为:{#map.get('newPassword')}")
public String useMap(@RequestParam HashMap<String, Object> map) {
  return "The password changed.";
}

注意事项:JDK1.8及以前的版本反射时无法获取源码参数的名称,可以通过#p?的格式化来获取参数对应值,其中?为参数的索引,从0开始。

如:#p0.get('userId')#p0.userId

自定义变量

如果格式化日志所需要的变量不是参数也不是返回值,这时我们需要自定义变量并加入到格式化日志的变量集合内,如下所示:

@GraceRecorder(category = "User", success = "用户:{#request.userId} 密码由{#oldPassword}改为{#request.newPassword}")
public void changePassword(ChangeUserPwdRequest request) {
  GraceVariableContext.setVariable("oldPassword", "admin123");
  // ...
}

GraceVariableContext内是一个多线程副本的HashMap集合,如果相同Key的变量设置多次会被覆盖使用最后一次设置的值。

使用Bean定义的函数

SpEL表达式支持通过@bean的方式来访问IOC容器内注册的Bean实例,也可以直接访问Bean定义的方法,如下所示:

@Service
public class UserService {
  public String getUserRealName(String userId) {
    return "恒宇少年";
  }
}
-------
  @GetMapping("/changePassword")
  @GraceRecorder(category = "Test", success = "修改用户:{@userService.getUserRealName(#map.get('userId'))}的密码,改后为:{#map.get('newPassword')}")
  public String useMap(@RequestParam HashMap<String, Object> map) {
  return "The password changed.";
}

格式:@ + Bean名称,如果没有特殊处理使用注解注册到IOC容器内的Bean名称首字母都为小写,所以@userService就代表了UserService类的Bean实例。

表达式函数

表达式函数必须是static修饰的方法才可以定义,如果不是static在访问时会报错,主要是因为反射调用方法时如果不是静态的需要方法所属类的实例才可以。

配置ExpressionFunctionFactory类

@Bean
ExpressionFunctionFactory expressionFunctionFactory() {
  // 可以传递多个basePackage
  return new ExpressionFunctionFactory(Arrays.asList("org.minbox.framework.grace.sample","com.yuqiyu"));
}

通过配置实例化ExpressionFunctionFactory类来加载指定包名下配置@GraceFunctionDefiner注解的类。

@GraceFunctionDefiner
public class StringUtils {
    @GraceFunction
    public static String reverseString(String input) {
        StringBuilder backwards = new StringBuilder();
        for (int i = 0; i < input.length(); i++) {
            backwards.append(input.charAt(input.length() - 1 - i));
        }
        return backwards.toString();
    }
}

@GraceFunctionDefiner注解只是起到了一个过滤表达式函数定义的作用,只要使用该注解的类才可以执行进一步解析表达式函数的逻辑。

@GraceFunction注解则是标识方法为表达式函数,ExpressionFunctionFactory在实例化后会把表达式函数缓存到内存集合中,在解析操作日志的SpEL表达式时进行注册使用。

使用返回值

每次执行@GraceRecorder配置的方法时,AOP拦截器都会在目标方法执行完成后将结果添加到上下文的变量集合内,使用result作为Key,如果我们需要使用返回值的内容来格式化日志可以直接使用#result来访问数据。

@GraceRecorder(category = "User", success = "用户:{#userId} 查询到的昵称为:{#result}")
public String getUserRealName(String userId) {
  return "恒宇少年";
}

@GraceRecorder(category = "User", success = "用户:{#userId},年龄:{#result.age}")
public User getUserById(String userId) {
  return new User();
}

@Data
public static class User {
  private String userId;
  private String userName;
  private int age;
}

条件判断

@GraceRecorder注解有个condition条件属性,支持SpEL表达式配置,如果配置了该属性,只有表达式解析结果为true时才会记录操作日志。

@GraceRecorder(category = "User", condition = "{#age>20 and #age<60}", success = "用户:{@userService.getUserRealName(#userId)},年龄超过{#age}")
public void updateAgeById(String userId, int age) {
  System.out.println(age);
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 142,061评论 1 300
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 60,947评论 1 255
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 93,744评论 0 211
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 40,878评论 0 175
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 48,601评论 1 255
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 38,696评论 1 175
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 30,324评论 2 267
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,120评论 0 165
  • 想象着我的养父在大火中拼命挣扎,窒息,最后皮肤化为焦炭。我心中就已经是抑制不住地欢快,这就叫做以其人之道,还治其人...
    爱写小说的胖达阅读 28,921评论 6 229
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 32,459评论 0 213
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,234评论 2 214
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 30,558评论 1 226
  • 白月光回国,霸总把我这个替身辞退。还一脸阴沉的警告我。[不要出现在思思面前, 不然我有一百种方法让你生不如死。]我...
    爱写小说的胖达阅读 24,203评论 0 31
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,088评论 2 213
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 31,460评论 3 204
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,604评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 25,975评论 0 166
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 33,460评论 2 230
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 33,536评论 2 229

推荐阅读更多精彩内容