Skip to content

Commit 51b4a67

Browse files
zcode-zjwzcode-zjw
committed
README update
1 parent 4169dfa commit 51b4a67

File tree

9 files changed

+244
-4
lines changed

9 files changed

+244
-4
lines changed

‎.idea/workspace.xml

Lines changed: 7 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎README.md

Lines changed: 135 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,136 @@
1-
# zcode-commons后端服务组件库
1+
<h1 align="center">zcode-commons后端服务组件库</h1>
22

3-
zcode-commons致力提供一个简易、快速、便捷的后端组件库，基于组件化开发的原则，做到需要什么用什么，灵活多变。其涵盖大部分开发场景，你无需从0出发就可轻松搭建自己的系统框架，使其专注于业务代码的编写，最佳实践。
3+
<div align="center">
4+
5+
</div>
6+
7+
<hr />
8+
9+
<h3 align="center">
10+
11+
💡 **组件说明** 💡
12+
13+
</h3>
14+
15+
| 组件 | 描述 |
16+
|-------------------|-----------|
17+
| common-auth | 通用认证限权组件 |
18+
| common-framework | 通用框架组件 |
19+
| common-config | 通用配置组件 |
20+
| common-datasource | 通用数据源组件 |
21+
| common-cache | 通用缓存组件 |
22+
| common-log | 通用日志组件 |
23+
| common-web | 通用Web组件 |
24+
| common-utils | 通用工具类组件 |
25+
| common-correspond | 通用通讯组件 |
26+
| common-middleware | 通用中间件组件 |
27+
| common-test | 通用测试组件 |
28+
| common-ssh | 通用ssh组件 |
29+
| common-cloud | 通用微服务组件 |
30+
| common-file | 通用文件组件 |
31+
| common-apiword | 通用接口文档组件 |
32+
| common-minio | 通用分布式文件组件 |
33+
| common-schedule | 通用调度组件 |
34+
| common-generator | 通用生成器组件 |
35+
| common-security | 通用安全组件 |
36+
37+
#### 配置文件（按需配置） 文件如下：
38+
39+
```
40+
组件主配置文件: zcode.properties
41+
运维主配置文件: oamp.properties
42+
监控配置文件: omap-monitor.properties
43+
SSH配置文件: omap-ssh.properties
44+
定时任务配置文件: omap-timetask.properties
45+
其他配置文件: omap-pool.properties
46+
```
47+
48+
<hr/>
49+
50+
<h3 align="center">
51+
52+
💡 **目前的领域** 💡
53+
54+
</h3>
55+
56+
| 范围 | 描述 | API | 数据来源 | 说明 |
57+
|------|---------------------------------------|-----|------|-----|
58+
| 认证 | 用户认证，可支持token和session | - | - | - |
59+
| 限权 | 用户限权 | - | - | - |
60+
| 数据源 | 支持Mysql、Oracle、PostgreSql数据库，支持多数据源切换 | - | - | - |
61+
| 数据安全 | 接口传输数据的加解密，支持RSA、AES、DES等多种加密算法 | - | - | - |
62+
| 调度 | 支持原生定时任务、QZ | | - | - |
63+
| 配置管理 | 组件和业务配置统一管理 | - | - | - |
64+
| Web | 支持数据脱敏、接口防重、全局异常处理、反爬、限流、防XSS、防CSRF等 | - | - | - |
65+
| 文件 | 支持上传、存储、下载 | - | - | - |
66+
| 通讯 | 支持WebSocket、Netty | - | - | - |
67+
| 缓存 | 支持本地缓存与Redis缓存 | | - | - |
68+
| 中间件 | 支持MQ、canal、email、ES等 | - | - | - |
69+
| 日志 | 支持操作日志、审计日志、日志追踪等 | - | - | - |
70+
| 微服务 | 支持nacos、sentinel、seata、gateway等 | - | - | - |
71+
| 低代码 | 支持本地客户端以及Web应用 | - | - | - |
72+
| 工具 | 涵盖日常开发所用工具类 | - | - | - |
73+
| 运维 | 支持服务管理、文件监控、端口监控、主机节点等 | - | - | - |
74+
| 部署 | 支持Docker打包 | - | - | - |
75+
<hr/>
76+
77+
<h3 align="center">
78+
79+
💡 **快速开始** 💡
80+
81+
</h3>
82+
83+
## 环境准备
84+
85+
jdk1.8、Mysql5.7以上
86+
87+
## 依赖安装
88+
89+
安装本地Maven，依赖下载推荐使用华为云镜像仓库，依赖详见主Pom.xml文件
90+
91+
## 脚本初始化
92+
93+
运行doc下的SQL文件
94+
95+
## 配置文件
96+
97+
将config下的文件拷贝至自己的项目resources目录下
98+
99+
## 组件引入
100+
101+
### 引入父依赖
102+
103+
```xml
104+
<parent>
105+
<groupId>com.zcode.zjw</groupId>
106+
<artifactId>zcode-commons</artifactId>
107+
<version>1.0.0</version>
108+
</parent>
109+
```
110+
111+
### 引入组件
112+
113+
```xml
114+
<parent>
115+
<groupId>com.zcode.zjw</groupId>
116+
<artifactId>zcode-utls</artifactId>
117+
</parent>
118+
```
119+
120+
### 使用
121+
122+
<hr />
123+
124+
<h3 align="center">
125+
📚 问题 📚
126+
<br />
127+
<br />
128+
如遇到任何问题，欢迎联系我，你的宝贵意见将成为我前进的动力
129+
130+
131+
<h3 align="center">
132+
133+
💡 支持 💡
134+
<br />
135+
<br />
136+
如需关注项目最新动态，请Watch、Star项目，同时也是对项目最好的支持

‎config/oamp-monitor.properties

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#\u6CE8\u91CA
2+
#Wed Jan 04 09:03:09 CST 2023
3+
monitor.fileDir=/root/test/
4+
monitor.fileSuffix=.java

‎config/oamp-pool.properties

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#\u6CE8\u91CA
2+
#Wed Jan 04 09:03:09 CST 2023
3+
websokect.coreSize=8
4+
websokect.awaitTerminationSeconds=60
5+
websokect.maxSize=16
6+
websokect.keepAliveSeconds=60
7+
websokect.queueCapacity=20

‎config/oamp-ssh.properties

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#\u6CE8\u91CA
2+
#Wed Jan 04 09:03:09 CST 2023
3+
ssh.minIdel=4
4+
ssh.maxIdle=4
5+
ssh.incrementalConnections=4
6+
ssh.maxConnections=10

‎config/oamp-timetask.properties

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#\u6CE8\u91CA
2+
#Wed Jan 04 09:03:09 CST 2023
3+
timetask.taskMaxPoolSize=4
4+
timetask.taskQueueSize=10
5+
timetask.schedulerPoolSize=8
6+
timetask.taskKeepAliveTime=60
7+
timetask.taskCorePoolSize=4

‎config/oamp.properties

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
#\u6CE8\u91CA
2+
#Wed Jan 04 09:03:09 CST 2023
3+
oamp.redisFlag=Redis
4+
oamp.memorialDay=false
5+
oamp.lineDebugDir=/root/service/aomake/debug/
6+
oamp.upgradePackageDir=/root/service/aomake/test/
7+
oamp.webappRegister=aomake
8+
oamp.redisDir=/root/service/aomake/redis-4.0.11/
9+
oamp.ownSiteDir=/root/service/aomake/
10+
oamp.middleRegister=apache-activemq-5.14.5
11+
oamp.webDir=/root/web/tomcat8/
12+
oamp.currentVersion=126
13+
oamp.lineDebugFlag=aomake-linedebug
14+
oamp.port=22
15+
oamp.webappFlag=aomake
16+
oamp.secretKeyPath=
17+
oamp.serviceDir=/root/service/aomake/
18+
oamp.host=127.0.0.1
19+
oamp.activeMqFlag=ActiveMQ
20+
oamp.serviceRegister=aomake-slave01,aomake-slave02
21+
oamp.mqDir=/root/service/mq/apache-activemq-5.14.5/
22+
oamp.flag=aomake-1.0.0
23+
oamp.password=aomake
24+
oamp.username=aomake
25+
oamp.nodeType=local
26+
oamp.printSql=true

‎config/redisson.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# redisson.yml --- 存放于application.yml同级目录
2+
singleServerConfig:
3+
# 连接空闲超时，单位：毫秒
4+
idleConnectionTimeout: 100000
5+
# 连接超时，单位：毫秒
6+
connectTimeout: 10000
7+
# 命令等待超时，单位：毫秒
8+
timeout: 3000
9+
# 命令失败重试次数
10+
retryAttempts: 3
11+
# 命令重试发送时间间隔，单位：毫秒
12+
retryInterval: 1500
13+
# 密码
14+
password: password
15+
# 单个连接最大订阅数量
16+
subscriptionsPerConnection: 5
17+
# 客户端名称
18+
clientName: null
19+
# 节点地址
20+
address: redis://localhost:6379
21+
# 发布和订阅连接的最小空闲连接数
22+
subscriptionConnectionMinimumIdleSize: 1
23+
# 发布和订阅连接池大小
24+
subscriptionConnectionPoolSize: 50
25+
# 最小空闲连接数
26+
connectionMinimumIdleSize: 32
27+
# 连接池大小
28+
connectionPoolSize: 64
29+
# redis数据库编号
30+
database: 12
31+
# DNS监测时间间隔，单位：毫秒
32+
dnsMonitoringInterval: 5000
33+
# 线程池数量
34+
threads: 0
35+
# Netty线程池数量
36+
nettyThreads: 0
37+
# 编码
38+
codec:
39+
class: "org.redisson.codec.JsonJacksonCodec"
40+
# 传输模式
41+
transportMode: "NIO"
42+
# 配置看门狗的默认超时时间为30s，这里改为10s
43+
lockWatchdogTimeout: 10000

‎config/zcode.properties

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
zcode.printSql=true
2+
zcode.swagger.title=Demo
3+
zcode.swagger.description=Demo
4+
zcode.swagger.version=1.0.0
5+
6+
zcode.ssh.host=localhost
7+
zcode.ssh.port=22
8+
zcode.ssh.username=mac
9+
zcode.nodeType=local

0 commit comments

Comments
 (0)