31
docs/databus-client使用说明.md
Normal file
31
docs/databus-client使用说明.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# Databus Client 使用说明
|
||||||
|
|
||||||
|
databus client 最主要用于调用基于http协议的第三方接口时需要记录调用日志到 databus 的情况, 通过databus client 调用第三方接口会将调用日志记录到databus的访问日志中
|
||||||
|
|
||||||
|
# 使用方法
|
||||||
|
1. 添加依赖:
|
||||||
|
```xml
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.zt.plat</groupId>
|
||||||
|
<artifactId>zt-module-databus-client</artifactId>
|
||||||
|
<version>3.0.47-SNAPSHOT</version>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
2. 注入 DatabusClient
|
||||||
|
```java
|
||||||
|
@Resource
|
||||||
|
private DatabusClient databusClient;
|
||||||
|
```
|
||||||
|
3. 方法说明
|
||||||
|
* get(...) : 发送 get 请求
|
||||||
|
* post(...): 发送 post 请求
|
||||||
|
* put(...): 发送 put 请求
|
||||||
|
* delete(...): 发送 delete 请求
|
||||||
|
* doRequest(...): 发送自定义请求
|
||||||
|
4. 方法参数说明(由于所有方法参数都是一样的,所以在此统一说明)
|
||||||
|
* String urlString: 请求的 http 接口地址(get/delete请求不需要带url参数)
|
||||||
|
* Map<String, Object> data: 请求的参数(post/put方法会转换为json提交, get/delete会拼接到url上)
|
||||||
|
* Map<String, String> headers: 请求头信息
|
||||||
|
* String appId: databus 的appid
|
||||||
|
* String authToken: databus 的访问令牌
|
||||||
|
* Method method: doRequest 方法独有,如果要使用 get/post/put/delete 之外的方法,请使用doRequest方法并通过method参数指定
|
||||||
@@ -8,7 +8,7 @@
|
|||||||
<groupId>com.zt.plat</groupId>
|
<groupId>com.zt.plat</groupId>
|
||||||
<version>${revision}</version>
|
<version>${revision}</version>
|
||||||
</parent>
|
</parent>
|
||||||
<artifactId>zt-module-databus-server-client</artifactId>
|
<artifactId>zt-module-databus-client</artifactId>
|
||||||
<packaging>jar</packaging>
|
<packaging>jar</packaging>
|
||||||
<name>${project.artifactId}</name>
|
<name>${project.artifactId}</name>
|
||||||
<description>
|
<description>
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ import cn.hutool.http.Method;
|
|||||||
import cn.hutool.json.JSONObject;
|
import cn.hutool.json.JSONObject;
|
||||||
import cn.hutool.json.JSONUtil;
|
import cn.hutool.json.JSONUtil;
|
||||||
import com.zt.plat.framework.common.pojo.CommonResult;
|
import com.zt.plat.framework.common.pojo.CommonResult;
|
||||||
import com.zt.plat.framework.common.util.security.CryptoSignatureUtils;
|
|
||||||
import com.zt.plat.module.databus.api.dto.ApiAccessLogCreateReq;
|
import com.zt.plat.module.databus.api.dto.ApiAccessLogCreateReq;
|
||||||
import com.zt.plat.module.databus.api.provider.DatabusAccessLogProviderApi;
|
import com.zt.plat.module.databus.api.provider.DatabusAccessLogProviderApi;
|
||||||
import jakarta.annotation.Resource;
|
import jakarta.annotation.Resource;
|
||||||
|
|||||||
@@ -91,6 +91,10 @@
|
|||||||
<logger name="com.zt.plat.module.infra.dal.mysql" level="DEBUG" additivity="false">
|
<logger name="com.zt.plat.module.infra.dal.mysql" level="DEBUG" additivity="false">
|
||||||
<appender-ref ref="STDOUT"/>
|
<appender-ref ref="STDOUT"/>
|
||||||
</logger>
|
</logger>
|
||||||
|
|
||||||
|
<logger name="com.zt.plat.module.system.dal.mysql" level="DEBUG" additivity="false">
|
||||||
|
<appender-ref ref="STDOUT"/>
|
||||||
|
</logger>
|
||||||
</springProfile>
|
</springProfile>
|
||||||
|
|
||||||
<!-- 其它环境 -->
|
<!-- 其它环境 -->
|
||||||
@@ -103,8 +107,4 @@
|
|||||||
</root>
|
</root>
|
||||||
</springProfile>
|
</springProfile>
|
||||||
|
|
||||||
<!-- <logger name="com.zt.plat.module.system.dal" level="DEBUG" additivity="false">-->
|
|
||||||
<!-- <appender-ref ref="STDOUT"/>-->
|
|
||||||
<!-- </logger>-->
|
|
||||||
|
|
||||||
</configuration>
|
</configuration>
|
||||||
|
|||||||
@@ -4,6 +4,8 @@ import com.zt.plat.framework.common.enums.CommonStatusEnum;
|
|||||||
import com.zt.plat.framework.common.pojo.CommonResult;
|
import com.zt.plat.framework.common.pojo.CommonResult;
|
||||||
import com.zt.plat.framework.common.pojo.CompanyDeptInfo;
|
import com.zt.plat.framework.common.pojo.CompanyDeptInfo;
|
||||||
import com.zt.plat.framework.common.util.object.BeanUtils;
|
import com.zt.plat.framework.common.util.object.BeanUtils;
|
||||||
|
import com.zt.plat.framework.datapermission.core.annotation.CompanyDataPermissionIgnore;
|
||||||
|
import com.zt.plat.framework.datapermission.core.annotation.DeptDataPermissionIgnore;
|
||||||
import com.zt.plat.module.system.api.dept.dto.*;
|
import com.zt.plat.module.system.api.dept.dto.*;
|
||||||
import com.zt.plat.module.system.controller.admin.dept.vo.dept.DeptListReqVO;
|
import com.zt.plat.module.system.controller.admin.dept.vo.dept.DeptListReqVO;
|
||||||
import com.zt.plat.module.system.controller.admin.dept.vo.dept.DeptSaveReqVO;
|
import com.zt.plat.module.system.controller.admin.dept.vo.dept.DeptSaveReqVO;
|
||||||
@@ -78,6 +80,8 @@ public class DeptApiImpl implements DeptApi {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@CompanyDataPermissionIgnore
|
||||||
|
@DeptDataPermissionIgnore
|
||||||
public CommonResult<DeptRespDTO> getDept(Long id) {
|
public CommonResult<DeptRespDTO> getDept(Long id) {
|
||||||
DeptDO dept = deptService.getDept(id);
|
DeptDO dept = deptService.getDept(id);
|
||||||
return success(BeanUtils.toBean(dept, DeptRespDTO.class));
|
return success(BeanUtils.toBean(dept, DeptRespDTO.class));
|
||||||
|
|||||||
@@ -798,7 +798,12 @@ public class IWorkSyncProcessorImpl implements IWorkSyncProcessor {
|
|||||||
if (StrUtil.isBlank(statusFlag)) {
|
if (StrUtil.isBlank(statusFlag)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
return !"0".equals(statusFlag.trim());
|
Integer status = parseInteger(statusFlag);
|
||||||
|
if (status == null) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
// iWork 状态:0试用、1正式、2临时、3试用延期、4解聘、5离职、6退休、7无效
|
||||||
|
return status >= 4;
|
||||||
}
|
}
|
||||||
|
|
||||||
private Integer resolveSex(String sexFlag) {
|
private Integer resolveSex(String sexFlag) {
|
||||||
|
|||||||
@@ -260,10 +260,10 @@ public class IWorkSyncServiceImpl implements IWorkSyncService {
|
|||||||
if (query == null || reqVO == null) {
|
if (query == null || reqVO == null) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
copyQueryParameters(reqVO, query); // 设置查询条件
|
||||||
if (StrUtil.isBlank(reqVO.getId())) {
|
if (StrUtil.isBlank(reqVO.getId())) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
copyQueryParameters(reqVO, query); // 设置查询条件
|
|
||||||
applyQueryId(query, reqVO.getId());
|
applyQueryId(query, reqVO.getId());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -5,6 +5,10 @@
|
|||||||
<springProperty scope="context" name="zt.info.base-package" source="zt.info.base-package"/>
|
<springProperty scope="context" name="zt.info.base-package" source="zt.info.base-package"/>
|
||||||
<!-- 格式化输出:%d 表示日期,%X{tid} SkWalking 链路追踪编号,%thread 表示线程名,%-5level:级别从左显示 5 个字符宽度,%msg:日志消息,%n是换行符 -->
|
<!-- 格式化输出:%d 表示日期,%X{tid} SkWalking 链路追踪编号,%thread 表示线程名,%-5level:级别从左显示 5 个字符宽度,%msg:日志消息,%n是换行符 -->
|
||||||
<property name="PATTERN_DEFAULT" value="%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} | %highlight(${LOG_LEVEL_PATTERN:-%5p} ${PID:- }) | %boldYellow(%thread [%tid]) %boldGreen(%-40.40logger{39}) | %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>
|
<property name="PATTERN_DEFAULT" value="%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} | %highlight(${LOG_LEVEL_PATTERN:-%5p} ${PID:- }) | %boldYellow(%thread [%tid]) %boldGreen(%-40.40logger{39}) | %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>
|
||||||
|
<!--应用名称-->
|
||||||
|
<springProperty scope="context" name="spring.application.name" source="spring.application.name"/>
|
||||||
|
<!-- 日志输出路径 -->
|
||||||
|
<property name="LOG_DIR" value="${user.home}/logs/${spring.application.name}"/>
|
||||||
|
|
||||||
<!-- 控制台 Appender -->
|
<!-- 控制台 Appender -->
|
||||||
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
|
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
|
||||||
@@ -31,7 +35,7 @@
|
|||||||
<!-- 启动服务时,是否清理历史日志,一般不建议清理 -->
|
<!-- 启动服务时,是否清理历史日志,一般不建议清理 -->
|
||||||
<cleanHistoryOnStart>${LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START:-false}</cleanHistoryOnStart>
|
<cleanHistoryOnStart>${LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START:-false}</cleanHistoryOnStart>
|
||||||
<!-- 日志文件,到达多少容量,进行滚动 -->
|
<!-- 日志文件,到达多少容量,进行滚动 -->
|
||||||
<maxFileSize>${LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE:-10MB}</maxFileSize>
|
<maxFileSize>${LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE:-50MB}</maxFileSize>
|
||||||
<!-- 日志文件的总大小,0 表示不限制 -->
|
<!-- 日志文件的总大小,0 表示不限制 -->
|
||||||
<totalSizeCap>${LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP:-0}</totalSizeCap>
|
<totalSizeCap>${LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP:-0}</totalSizeCap>
|
||||||
<!-- 日志文件的保留天数 -->
|
<!-- 日志文件的保留天数 -->
|
||||||
@@ -56,17 +60,42 @@
|
|||||||
</encoder>
|
</encoder>
|
||||||
</appender>
|
</appender>
|
||||||
|
|
||||||
|
<!-- ERROR 级别日志 -->
|
||||||
|
<appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
|
||||||
|
<file>${LOG_DIR}-error.log</file>
|
||||||
|
<filter class="ch.qos.logback.classic.filter.LevelFilter">
|
||||||
|
<level>ERROR</level>
|
||||||
|
<onMatch>ACCEPT</onMatch>
|
||||||
|
<onMismatch>DENY</onMismatch>
|
||||||
|
</filter>
|
||||||
|
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
|
||||||
|
<fileNamePattern>${LOG_DIR}-error.%d{yyyy-MM-dd}.log</fileNamePattern>
|
||||||
|
<maxHistory>30</maxHistory> <!-- 保留30天的日志 -->
|
||||||
|
</rollingPolicy>
|
||||||
|
<encoder>
|
||||||
|
<pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
|
||||||
|
</encoder>
|
||||||
|
</appender>
|
||||||
|
|
||||||
|
<!--logback的日志级别 FATAL > ERROR > WARN > INFO > DEBUG-->
|
||||||
<!-- 本地环境 -->
|
<!-- 本地环境 -->
|
||||||
<springProfile name="local">
|
<springProfile name="local,dev">
|
||||||
<root level="INFO">
|
<root level="WARN">
|
||||||
<appender-ref ref="STDOUT"/>
|
<appender-ref ref="STDOUT"/>
|
||||||
|
<appender-ref ref="ERROR"/>
|
||||||
<appender-ref ref="GRPC"/> <!-- 本地环境下,如果不想接入 SkyWalking 日志服务,可以注释掉本行 -->
|
<appender-ref ref="GRPC"/> <!-- 本地环境下,如果不想接入 SkyWalking 日志服务,可以注释掉本行 -->
|
||||||
<appender-ref ref="ASYNC"/> <!-- 本地环境下,如果不想打印日志,可以注释掉本行 -->
|
<appender-ref ref="ASYNC"/> <!-- 本地环境下,如果不想打印日志,可以注释掉本行 -->
|
||||||
</root>
|
</root>
|
||||||
|
<!--针对不同的业务路径,配置dao层的sql打印日志级别为DEBUG-->
|
||||||
|
<logger name="com.zt.plat.module.system.dal.mysql" level="DEBUG" additivity="false">
|
||||||
|
<appender-ref ref="STDOUT"/>
|
||||||
|
</logger>
|
||||||
</springProfile>
|
</springProfile>
|
||||||
|
|
||||||
<!-- 其它环境 -->
|
<!-- 其它环境 -->
|
||||||
<springProfile name="dev,test,stage,prod,default">
|
<springProfile name="test,stage,prod,default">
|
||||||
<root level="INFO">
|
<root level="INFO">
|
||||||
|
<appender-ref ref="ERROR"/>
|
||||||
<appender-ref ref="STDOUT"/>
|
<appender-ref ref="STDOUT"/>
|
||||||
<appender-ref ref="ASYNC"/>
|
<appender-ref ref="ASYNC"/>
|
||||||
<appender-ref ref="GRPC"/>
|
<appender-ref ref="GRPC"/>
|
||||||
|
|||||||
Reference in New Issue
Block a user