Skip to content

Commit 4144542

Browse files
authored
Merge pull request #18 from yeecode/develop
update README
2 parents e4caa19 + fe8dc63 commit 4144542

File tree

8 files changed

+39
-14
lines changed

8 files changed

+39
-14
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ ObjectLogger is powerful and easy-to-use object log system, which supports writi
2222

2323
It can be used in many scenarios, such as user operation log record, object attribute change record and so on.
2424

25-
![react-object-logger demo](./pic/react_en.png)
25+
<div align=center>
26+
<img width="90%" src="./pic/react_en.png"/>
27+
</div>
2628

2729
The system has the following characteristics:
2830

@@ -67,7 +69,9 @@ The above configuration items are described below:
6769

6870
After starting the jar package, you can see:
6971

70-
![server_start](./pic/server_start.png)
72+
<div align=center>
73+
<img width="80%" src="./pic/server_start.png"/>
74+
</div>
7175

7276
The default welcome page is:
7377

@@ -77,7 +81,9 @@ http://127.0.0.1:12301/ObjectLoggerServer/
7781

7882
Visit the above address to see the following welcome interface:
7983

80-
![welcome interface](./pic/100.jpg)
84+
<div align=center>
85+
<img width="80%" src="./pic/100.jpg"/>
86+
</div>
8187

8288
The ObjectLoggerServer system has been built.
8389

@@ -87,7 +93,9 @@ This section explains how to configure the business system to analyze the object
8793

8894
The use of this part can refer to the ObjectLoggerDemo project, which gives a detailed example of business system integration ObjectLoggerClient. ObjectLoggerDemo's product package can be obtained from `/demo/target/ObjectLoggerDemo-*. jar`, and the project can be started directly without any other configuration by running `java -jar ObjectLoggerDemo-*. jar`.
8995

90-
![demo_start](./pic/demo_start.png)
96+
<div align=center>
97+
<img width="90%" src="./pic/demo_start.png"/>
98+
</div>
9199

92100
## 3.1 Add Dependency
93101

@@ -146,14 +154,18 @@ At this point, the configuration of the business system is completed.
146154

147155
The logs recorded in the system can be queried by `http://127.0.0.1:12301/ObjectLoggerServer/log/query`, and the logs can be filtered by passing in parameters.
148156

149-
![demo](./pic/api.gif)
157+
<div align=center>
158+
<img width="90%" src="./pic/api.gif"/>
159+
</div>
150160

151161
# 5 Show Logs
152162

153163

154164
[react-object-logger](https://github.com/promise-coding/react-object-logger) is the react plugin for ObjectLogger project to show logs in web. Demo: [react-object-logger demo](https://promise-coding.github.io/react-object-logger/)
155165

156-
![react-object-logger demo](./pic/react_en.png)
166+
<div align=center>
167+
<img width="90%" src="./pic/react_en.png"/>
168+
</div>
157169

158170
More information can be obtained via [react-object-logger](https://github.com/promise-coding/react-object-logger).
159171

@@ -404,6 +416,7 @@ public class ExtendedTypeHandler implements BaseExtendedTypeHandler {
404416
public BaseAttributeModel handleAttributeChange(String extendedType, String attributeName, String attributeAlias, Object oldValue, Object newValue) {
405417
BaseAttributeModel baseAttributeModel = new BaseAttributeModel();
406418
if (extendedType.equals("userIdType")) {
419+
// 这里仅作示例,实际使用中可以进行调用用户系统将userId转化为userName的操作等
407420
baseAttributeModel.setOldValue("USER_" + oldValue);
408421
baseAttributeModel.setNewValue("USER_" + newValue);
409422
baseAttributeModel.setDiffValue(oldValue + "->" + newValue);

README_CN.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="left">
2-
<img src="./pic/ObjectLogger.png" height="80px" alt="ObjectLogger" >
2+
<img src="./pic/ObjectLogger.png" height="80px" alt="ObjectLogger" >
33
</div>
44

55
# [ObjectLogger](https://github.com/yeecode/ObjectLogger)
@@ -8,7 +8,7 @@
88
[![codebeat badge](https://codebeat.co/badges/94beca78-0817-4a27-9544-326afe35339f)](https://codebeat.co/projects/github-com-yeecode-objectlogger-master)
99
![license](https://img.shields.io/badge/license-Apache-brightgreen.svg)
1010

11-
强大且易用的Java对象日志记录系统,支持对象属性变动的记录与查询
11+
强大且易用的Java对象日志记录系统,支持对象属性变化的自动分析、记录、查询
1212

1313
---
1414

@@ -20,7 +20,9 @@
2020

2121
ObjectLogger是一套强大且易用的对象日志记录系统。它能够将任意对象的变动日志记录下来,并支持查询。可以应用在用户操作日志记录、对象属性变更记录等诸多场景中。
2222

23-
![实例图片](./pic/react_en.png)
23+
<div align=center>
24+
<img width="90%" src="./pic/react_en.png"/>
25+
</div>
2426

2527
该系统具有以下特点:
2628

@@ -65,7 +67,9 @@ java -jar ObjectLoggerServer-*.jar --spring.datasource.driver-class-name={db_dri
6567

6668
启动jar成功后可以看到下面的界面:
6769

68-
![启动页面](./pic/server_start.png)
70+
<div align=center>
71+
<img width="80%" src="./pic/server_start.png"/>
72+
</div>
6973

7074
使用浏览器访问下面的页面可以看到系统欢迎页面:
7175

@@ -75,7 +79,9 @@ http://127.0.0.1:12301/ObjectLoggerServer/
7579

7680
访问上述地址可以看到下面的欢迎界面:
7781

78-
![系统首页](./pic/100.jpg)
82+
<div align=center>
83+
<img width="80%" src="./pic/100.jpg"/>
84+
</div>
7985

8086
至此,ObjectLoggerServer系统已经搭建结束,可以接受业务系统的日志写入和查询操作。
8187

@@ -87,7 +93,9 @@ http://127.0.0.1:12301/ObjectLoggerServer/
8793

8894
可以直接根据启动页面的提示访问相关地址来体验:
8995

90-
![demo_start](./pic/demo_start.png)
96+
<div align=center>
97+
<img width="90%" src="./pic/demo_start.png"/>
98+
</div>
9199

92100
## 3.1 引入依赖包
93101

@@ -145,7 +153,9 @@ yeecode.objectLogger.autoLogAttributes=true
145153

146154
系统运行后,可以通过`http://127.0.0.1:12301/ObjectLoggerServer/log/query`查询系统中记录的日志,并通过传入参数对日志进行过滤。
147155

148-
![实例图片](./pic/api.gif)
156+
<div align=center>
157+
<img width="90%" src="./pic/api.gif"/>
158+
</div>
149159

150160
通过这里,我们可以查询下一步中写入的日志。
151161

@@ -155,7 +165,9 @@ ObjectLogger有前端React组件[react-object-logger](https://github.com/promise
155165

156166
展示效果如图:
157167

158-
![react-object-logger实例图片](./pic/react.png)
168+
<div align=center>
169+
<img width="90%" src="./pic/react.png"/>
170+
</div>
159171

160172
感兴趣的用户可以前往[react-object-logger](https://github.com/promise-coding/react-object-logger)进行了解。
161173

pic/001.jpg

-39.5 KB
Binary file not shown.

pic/002.jpg

-46.1 KB
Binary file not shown.

pic/003.jpg

-55.2 KB
Binary file not shown.

pic/004.jpg

-39.7 KB
Binary file not shown.

pic/005.jpg

-41.8 KB
Binary file not shown.

pic/006.jpg

-35.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)