Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bes2008/audit
A common audit framework for java application
https://github.com/bes2008/audit
4a audit auditing java spring
Last synced: about 1 month ago
JSON representation
A common audit framework for java application
- Host: GitHub
- URL: https://github.com/bes2008/audit
- Owner: bes2008
- License: apache-2.0
- Created: 2020-04-10T06:09:57.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T20:57:24.000Z (7 months ago)
- Last Synced: 2024-04-06T03:37:21.054Z (7 months ago)
- Topics: 4a, audit, auditing, java, spring
- Language: Java
- Homepage:
- Size: 912 KB
- Stars: 29
- Watchers: 2
- Forks: 7
- Open Issues: 61
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Audit: audit-core/pom.xml
Awesome Lists containing this project
README
# audit
一个通用的 Audit （审计）框架。如果要接入4A审计时，特别方便哟，同时也高度定制化。
[](https://search.maven.org/search?q=g:io.github.bes2008.solution.audit%20AND%20v:2.3.20)
[教程](./.wiki/index.md)
# 目前该项目，已归档，停止更新。已将所有代码合并到 agileway项目中，如有问题，可以在agileway中提出，在那里修复。
## Features
1. 操作定义支持多种方式
+ @Operation 注解方式
+ 在 yaml 配置文件配置方法全名的方式
+ 在 yaml 配置文件配置 URL template 的方式
+ 允许自定义
2. 操作资源获取支持多种方式
+ 在 yaml 配置方法参数名称的方式
+ 支持注解方式
+ 支持List, Map, Entity解析等
+ 支持自定义
3. 支持 JDK6+
4. 支持 Java, Web应用
## Example
给一个SpringBoot应用快速加上审计功能，也可以直接去参考 audit-examples-springmvcdemo
第一步：引入相关Jar包
```xml
io.github.bes2008.solution.audit
audit-spring-boot-starter
${audit.version}
```
第二步：在application.yml中配置审计功能
```yaml
audit:
enabled: true # 开关
async-mode: false # 异步模式执行，还是同步模式执行，对于 web应用目前暂时强制采用同步模式
topics: [DEFAULT, LOGIN_LOGOUT]
topic-configs:
- name: DEFAULT
ring-buffer-size: 1024
producer-type: MULTI
- name: LOGIN_LOGOUT # topic的name
ring-buffer-size: 512 # topic的 ring buffer size ,强制要求是 pow(2)
producer-type: SINGLE # 生产者是单线程，还是多线程，可选值是 SINGLE,MULTI
http-interceptor-patterns: # Spring MVC HandlerInterceptor的拦截 pathPatterns
- /consumers/**
- /users/**
advisor-pointcut:
expression: execution(public * com.jn.audit.examples.springmvcdemo.common.controller.*Controller.*(..))
```
第三步：设置操作定义
参考 audit-examples-springmvcdemo 下的 operation.yml文件
第四步：在application.yml中配置定义文件位置
```yml
operation:
definition: # 操作定义
location: classpath:/operation.yml # 目前只内置了 yml风格的配置文件
reload-interval-in-seconds: 60 # 如果值 >0 则会定时的重新加载，在开发环境下有很有用
```
只需上述4步，然后访问应用就会有相应的日志产生。
如果想把审计日志写入数据库，或者需要自定义审计日志消费者，只需要实现 com.jn.audit.mq.Consumer接口并订阅响应的topic即可。
可以参考：audit-examples/audit-examples-springmvcdemo 中的AuditConfig.java
```java
import com.jn.audit.core.Auditor;
import com.jn.audit.examples.springmvcdemo.service.DbService;
import com.jn.audit.mq.MessageTopicDispatcher;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
@Configuration
public class AuditConfig {
private DbService dbService;
public DbService getDbService() {
return dbService;
}
/**
* 这是一个自定义的写入数据库的 Consumer
*/
@Autowired
public void setDbService(Auditor auditor, DbService dbService) {
this.dbService = dbService;
MessageTopicDispatcher dispatcher = auditor.getMessageTopicDispatcher();
dispatcher.subscribe("DEFAULT", dbService);
}
}
```
## [推广](https://github.com/fangjinuo)
+ langx 系列
- [langx-js](https://github.com/fangjinuo/langx-js)：TypeScript, JavaScript tools
- [langx-java](https://github.com/fangjinuo/langx-java): Java tools ，可以替换guava, apache commons-lang,io, hu-tool等
+ [easyjson](https://github.com/fangjinuo/easyjson): 一个通用的JSON库门面，可以无缝的在各个JSON库之间切换，就像slf4j那样。
+ [sqlhelper](https://github.com/fangjinuo/sqlhelper): SQL工具套件（通用分页、DDL Dump、SQLParser、URL Parser、批量操作工具等）。
+ [esmvc](https://github.com/fangjinuo/es-mvc): ElasticSearch 通用客户端，就像MyBatis Mapper那样顺滑
+ [agileway](https://github.com/fangjinuo/agileway): 常用框架扩展
+ [audit](https://github.com/fangjinuo/audit)：通用的Java应用审计框架
## 鸣谢
最后，感谢 Jetbrains 提供免费License，方便了开源项目的发展。
[](https://www.jetbrains.com/zh-cn/)