update docs

This commit is contained in:
huoyo 2021-04-27 22:14:07 +08:00
parent edf64b9b5f
commit fba7ce6b2c
4 changed files with 17 additions and 76 deletions

View File

@ -22,69 +22,6 @@ http://huoyo.gitee.io/ko-time
> * 由于对项目中每个方法进行监控,在性能层面会有一点影响,建议在开发阶段使用 > * 由于对项目中每个方法进行监控,在性能层面会有一点影响,建议在开发阶段使用
#### 使用教程
1. 引入依赖 或者 下载发行版本
```
<dependency>
<groupId>cn.langpy</groupId>
<artifactId>ko-time</artifactId>
<version>1.8</version>
</dependency>
```
```
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-${freemarker或者thymeleaf任选一个}</artifactId>
</dependency>
```
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还请告知 1.本项目使用java8开发其他版本未曾试验如有什么bug还请告知
2.v1.5及以下版本默认使用了freemarker模板其余版本可选用thymeleaf需要自行引入
```
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
<version>xxxx</version>
</dependency>
```
3.项目使用@Aspect注解,未引入 aop相关包的自行引入如aspectj或者spring-boot-starter-aop

View File

@ -39,6 +39,12 @@
## 访问 ## 访问
> 注意:
> 1.引入了上面的依赖和配置以后确认项目中是否有aop相关的包koTime使用了@Aspect注解未引入的自行引入如aspectj或者spring-boot-starter-aop
> 2.做完前面的步骤koTime的集成已经完毕无需进行其他配置
* 启动项目访问 `/koTime` 路径即可 * 启动项目访问 `/koTime` 路径即可

View File

@ -18,7 +18,7 @@
coverpage: true, coverpage: true,
loadSidebar: true, loadSidebar: true,
onlyCover: false, onlyCover: false,
subMaxLevel: 2 subMaxLevel: 3
} }
</script> </script>

View File

@ -4,10 +4,19 @@ koTime使用了@Aspect注解未引入 aop相关包的自行引入如aspect
## 前端展示模板冲突 ## 前端展示模板冲突
koTime提供freemark和thymeleaf两种模板根据自身项目的模板进行选择 * 前后端分离的项目
koTime提供freemark和thymeleaf两种模板可根据自己的爱好自由选择如果喜欢其他的koTime暂不支持你的喜欢
* 前后端不分离的项目
如果项目中使用了除了freemarker和thymeleaf之外的模板那么koTime暂时不支持 如果项目中使用了除了freemarker和thymeleaf之外的模板那么koTime暂时不支持
如果发生资源文件和配置的冲突,可取消`spring.profiles.active=koTime`这一步配置
然后将koTime中对于freemarker和thymeleaf的配置与自身的进行合并
## 是否支持前后端分离项目 ## 是否支持前后端分离项目
支持!目前来看,对前后端分离的项目比较友好,不分离的项目可能存在资源的文件影响 支持!目前来看,对前后端分离的项目比较友好,不分离的项目可能存在资源的文件影响