From fba7ce6b2c69617fbd574f00687d9e3dbdd66948 Mon Sep 17 00:00:00 2001
From: huoyo <1729913829@qq.com>
Date: Tue, 27 Apr 2021 22:14:07 +0800
Subject: [PATCH] update docs
---
README.md | 74 -----------------------------------------------
docs/getstart.md | 6 ++++
docs/index.html | 2 +-
docs/questions.md | 11 ++++++-
4 files changed, 17 insertions(+), 76 deletions(-)
diff --git a/README.md b/README.md
index 97be1f9..681f085 100644
--- a/README.md
+++ b/README.md
@@ -22,69 +22,6 @@ http://huoyo.gitee.io/ko-time
> * 由于对项目中每个方法进行监控，在性能层面会有一点影响，建议在开发阶段使用
-#### 使用教程
-
-1. 引入依赖 或者 下载发行版本
-```
-
- cn.langpy
- ko-time
- 1.8
-
-```
-
-```
-
- org.springframework.boot
- spring-boot-starter-${freemarker或者thymeleaf任选一个}
-
-```
-2. 配置信息
-
-在application.yml中配置
-```
-spring.profiles.active=koTime
-koTime.log.enable=false # 是否开启控制输出，非必填，默认false
-koTime.log.language=chinese # 控制台输出语言（english/chinese）非必填，默认chinese
-koTime.time.threshold=800.0 # 时间阈值，用于前端展示，大于阈值显示红色，小于阈值显示绿色，非必填，默认800
-koTime.pointcut=execution(* com.huoyo.demo.controller.*(..)) || execution(* com.huoyo.demo.service.*(..)) 需要监测的切面范围（比如监测controller层和service层），参考aop的@pointcut v1.4开始加入的功能，用来替代下面的步骤3
-koTime.ui.template=thymeleaf 前端页面模板，非必填，默认为freemarker，可选thymeleaf 与引入的pom依赖对应
-```
-
-
-
-3. 新建一个类，实现ComputeTimeHandlerInterface，并在 @Pointcut 写入 需要监测的范围
-
-`注意：v1.3之前需要该步骤，v1.4及以上使用koTime.pointcut配置即可，无需此步骤`
-
-```java
-@Component
-@Aspect
-public class RunTimeHandler implements ComputeTimeHandlerInterface {
- @Override
- @Pointcut("execution(* com.huoyo..*.*(..))")
- public void prog() {
-
- }
-}
-
-```
-
-4. 启动项目访问 `/koTime` 路径即可
-
-比如：`http://localhost:8080/koTime`
-如果项目自定义的contextpath，访问如`http://localhost:8080/xxx服务/koTime`
-
-5. 其他使用
-
-对于单个方法的监测，可以使用@ComputeTime注解
-
-```java
- @ComputeTime
- public void test() {
-
- }
-```
#### 可视化展示
@@ -130,16 +67,5 @@ public class RunTimeHandler implements ComputeTimeHandlerInterface {
1.本项目使用java8开发，其他版本未曾试验，如有什么bug还请告知！
-2.v1.5及以下版本默认使用了freemarker模板（其余版本可选用thymeleaf），需要自行引入
-
-```
-
- org.springframework.boot
- spring-boot-starter-freemarker
- xxxx
-
-```
-
-3.项目使用@Aspect注解，未引入 aop相关包的自行引入，如aspectj或者spring-boot-starter-aop
diff --git a/docs/getstart.md b/docs/getstart.md
index 41c3428..3030a55 100644
--- a/docs/getstart.md
+++ b/docs/getstart.md
@@ -39,6 +39,12 @@
## 访问
+> 注意：
+> 1.引入了上面的依赖和配置以后，确认项目中是否有aop相关的包，koTime使用了@Aspect注解，未引入的自行引入，如aspectj或者spring-boot-starter-aop
+> 2.做完前面的步骤，koTime的集成已经完毕，无需进行其他配置
+
+
+
* 启动项目访问 `/koTime` 路径即可
diff --git a/docs/index.html b/docs/index.html
index 1a9109b..43f1ed7 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -18,7 +18,7 @@
coverpage: true,
loadSidebar: true,
onlyCover: false,
- subMaxLevel: 2
+ subMaxLevel: 3
}
diff --git a/docs/questions.md b/docs/questions.md
index 8cdeff0..2fc7421 100644
--- a/docs/questions.md
+++ b/docs/questions.md
@@ -4,10 +4,19 @@ koTime使用了@Aspect注解，未引入 aop相关包的自行引入，如aspect
## 前端展示模板冲突
-koTime提供freemark和thymeleaf两种模板，根据自身项目的模板进行选择
+* 前后端分离的项目
+
+koTime提供freemark和thymeleaf两种模板，可根据自己的爱好自由选择，如果喜欢其他的，koTime暂不支持你的喜欢
+
+* 前后端不分离的项目
如果项目中使用了除了freemarker和thymeleaf之外的模板，那么koTime暂时不支持
+如果发生资源文件和配置的冲突，可取消`spring.profiles.active=koTime`这一步配置
+然后将koTime中对于freemarker和thymeleaf的配置与自身的进行合并
+
+
+
## 是否支持前后端分离项目
支持！目前来看，对前后端分离的项目比较友好，不分离的项目可能存在资源的文件影响