templates/maquan-module-template
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
maxiuxiang
2024-10-08 18:02:49 +08:00
commit bf66b9fa9a
55 changed files with 578 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
template/.gitignore vendored Normal file
View File

@@ -0,0 +1,24 @@
bin/
classes/
.settings/
.classpath
.project
*.iml
.idea/
HELP.md
!.idea/dataSources.xml
.vscode/
.factorypath
target/
test-output/
mvnw
mvnw.cmd
.DS_Store
logs/
*.log

5
template/common/README.md Normal file
View File

@@ -0,0 +1,5 @@
> 本模块存放公共组件
``` \-- *.utils(工具类; package)
\-- *.enums(公共枚举; package)
\-- *.constants(公共常量; package)
```

33
template/common/pom.xml Normal file
View File

@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}</artifactId>
<version>{{ .version }}</version>
</parent>
<artifactId>{{ .artifactId }}-common</artifactId>
<version>{{ .version }}</version>
<dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>javax.annotation</groupId>
<artifactId>javax.annotation-api</artifactId>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
</dependency>
</dependencies>
</project>

2
template/common/src/main/java/{{.packagePath}}/common/constants/README.md Normal file
View File

@@ -0,0 +1,2 @@
> 本模块存放公共常量
``` \-- *Constant.java

2
template/common/src/main/java/{{.packagePath}}/common/enums/README.md Normal file
View File

@@ -0,0 +1,2 @@
> 本模块存放公共枚举
``` \-- *Enum.java

3
template/common/src/main/java/{{.packagePath}}/common/utils/README.md Normal file
View File

@@ -0,0 +1,3 @@
> 本模块存放公共工具类
``` \-- *Util.java
```

1
template/common/src/main/resources/README.md Normal file
View File

@@ -0,0 +1 @@
> 本模块存放SQL

26
template/entrance/README.md Normal file
View File

@@ -0,0 +1,26 @@
本模块为 ```访问入口层```
```
\-- web(web访问; sub-module)
\-- *.controller(package)
\-- *.converter(package)
\-- *.vo(显示层对象； package)
\-- *.utils(工具类； package)
\-- job(任务; sub-module)
\-- *.job(job定义，以Job为后缀; package)
\-- *.dto(数据结构; package)
\-- *.converter(package)
\-- *.utils(工具类; package)
\-- mq(消息消费处理; sub-module)
\-- *.consumer(package)
\-- *.dto(数据结构; package)
\-- *.converter(package)
\-- *.utils(工具类; package)
\-- rpc(对外提供rpc; sub-module)
\-- *.RpcService(package)
\-- *.dto(数据结构; package)
\-- *.converter(package)
\-- *.utils(工具类; package)
```

13
template/entrance/job/pom.xml Normal file
View File

@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-entrance</artifactId>
<version>{{ .version }}</version>
</parent>
<artifactId>{{ .artifactId }}-entrance-job</artifactId>
</project>

4
template/entrance/job/src/main/java/{{.packagePath}}/entrance/job/converter/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放dtoConverter
```
\-- *Converter.java
```

4
template/entrance/job/src/main/java/{{.packagePath}}/entrance/job/dto/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放dto
```
\-- *DTO.java
```

4
template/entrance/job/src/main/java/{{.packagePath}}/entrance/job/job/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放job file
```
\-- *Job.java
```

4
template/entrance/job/src/main/java/{{.packagePath}}/entrance/job/utils/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放工具类
```
\-- *Util.java
```

19
template/entrance/mq/pom.xml Normal file
View File

@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-entrance</artifactId>
<version>{{ .version }}</version>
</parent>
<artifactId>{{ .artifactId }}-entrance-mq</artifactId>
<dependencies>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-service</artifactId>
</dependency>
</dependencies>
</project>

4
template/entrance/mq/src/main/java/{{.packagePath}}/entrance/mq/consumer/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放消息消费者
```
\-- *Consumer.java
```

4
template/entrance/mq/src/main/java/{{.packagePath}}/entrance/mq/converter/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放DTOConverter
```
\-- *Converter.java
```

4
template/entrance/mq/src/main/java/{{.packagePath}}/entrance/mq/dto/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放DTO
```
\-- *DTO.java
```

4
template/entrance/mq/src/main/java/{{.packagePath}}/entrance/mq/utils/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放工具类
```
\-- *Util.java
```

29
template/entrance/pom.xml Normal file
View File

@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}</artifactId>
<version>{{ .version }}</version>
</parent>
<artifactId>{{ .artifactId }}-entrance</artifactId>
<version>{{ .version }}</version>
<packaging>pom</packaging>
<dependencies>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-common</artifactId>
</dependency>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .parentArtifactId }}-common</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>
<modules>
<module>job</module>
<module>mq</module>
<module>web</module>
<module>rpc</module>
</modules>
</project>

20
template/entrance/rpc/pom.xml Normal file
View File

@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-entrance</artifactId>
<version>{{ .version }}</version>
</parent>
<artifactId>{{ .artifactId }}-entrance-rpc</artifactId>
<dependencies>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-service</artifactId>
</dependency>
</dependencies>
</project>

4
template/entrance/rpc/src/main/java/{{.packagePath}}/entrance/rpc/converter/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放DTOConverter
```
\-- *Converter.java
```

4
template/entrance/rpc/src/main/java/{{.packagePath}}/entrance/rpc/dto/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放DTO
```
\-- *DTO.java
```

4
template/entrance/rpc/src/main/java/{{.packagePath}}/entrance/rpc/utils/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放工具类
```
\-- *Util.java
```

22
template/entrance/web/pom.xml Normal file
View File

@@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-entrance</artifactId>
<version>{{ .version }}</version>
</parent>
<artifactId>{{ .artifactId }}-entrance-web</artifactId>
<version>{{ .version }}</version>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-service</artifactId>
</dependency>
</dependencies>
</project>

4
template/entrance/web/src/main/java/{{.packagePath}}/entrance/web/controller/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放Controller
```
\-- *Controller.java
```

4
template/entrance/web/src/main/java/{{.packagePath}}/entrance/web/converter/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放VOConverter
```
\-- *VOConverter.java
```

4
template/entrance/web/src/main/java/{{.packagePath}}/entrance/web/utils/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放工具类
```
\-- *Util.java
```

4
template/entrance/web/src/main/java/{{.packagePath}}/entrance/web/vo/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放VO
```
\-- *VO.java
```

9
template/manager/README.md Normal file
View File

@@ -0,0 +1,9 @@
本模块为 ```通用业务逻辑层```
```
\-- *.mananger(通用业务逻辑层接口定义，以Manager为后缀; package) \-- *.impl(通用业务逻辑层接口实现，以ManagerImpl为后缀; package)
\-- *.dto(业务层数据结构; package)
\-- *.converter(package)
\-- *.facade(remote stub(调用外部rpc); package)
\-- *.utils(工具类; package)
```

33
template/manager/pom.xml Normal file
View File

@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}</artifactId>
<version>{{ .version }}</version>
</parent>
<artifactId>{{ .artifactId }}-manager</artifactId>
<version>{{ .version }}</version>
<dependencies>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .parentArtifactId }}-common</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-persist</artifactId>
</dependency>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-common</artifactId>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
</dependency>
</dependencies>
</project>

4
template/manager/src/main/java/{{.packagePath}}/manager/converter/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放DTOConverter
```
\-- *DTOConverter.java
```

4
template/manager/src/main/java/{{.packagePath}}/manager/dto/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放DTO
```
\-- *DTO.java
```

4
template/manager/src/main/java/{{.packagePath}}/manager/facade/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放RpcServiceAdapter
```
\-- *RpcServiceAdapter.java
```

4
template/manager/src/main/java/{{.packagePath}}/manager/impl/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放ManagerImpl
```
\-- *ManagerImpl.java
```

4
template/manager/src/main/java/{{.packagePath}}/manager/impl/base/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放BaseManagerImpl
```
\-- *BaseManagerImpl.java
```

4
template/manager/src/main/java/{{.packagePath}}/manager/utils/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放工具类
```
\-- *Util.java
```

40
template/manager/src/main/resources/hibernate.cfg.xml Normal file
View File

@@ -0,0 +1,40 @@
<?xml version='1.0' encoding='utf-8'?>
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<!DOCTYPE hibernate-configuration PUBLIC
"-//Hibernate/Hibernate Configuration DTD 3.0//EN"
"http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
<session-factory>
<!-- Database connection settings -->
<property name="connection.driver_class">com.mysql.cj.jdbc.Driver</property>
<property name="connection.url">jdbc:mysql://localhost:3306/test</property>
<property name="connection.username">root</property>
<property name="connection.password">xi@2343JED$</property>
<!-- JDBC connection pool (use the built-in) -->
<property name="connection.pool_size">10</property>
<!-- SQL dialect -->
<property name="dialect">org.hibernate.dialect.MySQLDialect</property>
<!-- Disable the second-level cache
<property name="cache.provider_class">org.hibernate.cache.internal.NoCacheProvider</property>
-->
<!-- Echo all executed SQL to stdout -->
<property name="show_sql">true</property>
<!-- Drop and re-create the database schema on startup
<property name="hbm2ddl.auto">create</property>
-->
</session-factory>
</hibernate-configuration>

5
template/module Normal file
View File

@@ -0,0 +1,5 @@
id={{ .moduleId }}
name={{ .moduleName | replace "-" "_" }}
projectId={{ .projectId }}
projectName={{ .projectName }}
applicationName={{ .applicationName }}

2
template/persist/README.md Normal file
View File

@@ -0,0 +1,2 @@
## 本模块是 ```存储层 ```
> 对manager和service层可见

30
template/persist/pom.xml Normal file
View File

@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}</artifactId>
<version>{{ .version }}</version>
</parent>
<artifactId>{{ .artifactId }}-persist</artifactId>
<version>{{ .version }}</version>
<dependencies>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .parentArtifactId }}-common</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-common</artifactId>
</dependency>
<dependency>
<groupId>org.flywaydb</groupId>
<artifactId>flyway-core</artifactId>
</dependency>
</dependencies>
</project>

4
template/persist/src/main/java/{{.packagePath}}/persist/auto/provider/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放SqlProvider
```
\-- *SqlProvider.java
```

4
template/persist/src/main/java/{{.packagePath}}/persist/dos/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放meta
```
\-- *.java
```

4
template/persist/src/main/java/{{.packagePath}}/persist/mapper/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放Mapper
```
\-- *Mapper.java
```

4
template/persist/src/main/java/{{.packagePath}}/persist/mapper/base/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放BaseMapper
```
\-- Base*Mapper.java
```

4
template/persist/src/main/java/{{.packagePath}}/persist/utils/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放工具类
```
\-- *Util.java
```

1
template/persist/src/main/resources/db/migration/README.md Normal file
View File

@@ -0,0 +1 @@
> 本模块存放SQL

88
template/pom.xml Normal file
View File

@@ -0,0 +1,88 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}</artifactId>
<version>{{ .version }}</version>
<packaging>pom</packaging>
<parent>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .parentArtifactId }}</artifactId>
<version>1.0-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<dependencies>
<dependency>
<groupId>com.toco</groupId>
<artifactId>toco-all</artifactId>
<type>pom</type>
<version>1.0.0-SNAPSHOT</version>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .parentArtifactId }}-common</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-common</artifactId>
<version>{{ .version }}</version>
</dependency>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-service</artifactId>
<version>{{ .version }}</version>
</dependency>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-persist</artifactId>
<version>{{ .version }}</version>
</dependency>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-manager</artifactId>
<version>{{ .version }}</version>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-archetype-plugin</artifactId>
<version>3.2.1</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.3.0</version>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>3.3.1</version>
<configuration>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
</build>
<modules>
<module>persist</module>
<module>service</module>
<module>common</module>
<module>manager</module>
<module>entrance</module>
</modules>
</project>

35
template/service/pom.xml Normal file
View File

@@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}</artifactId>
<version>{{ .version }}</version>
</parent>
<artifactId>{{ .artifactId }}-service</artifactId>
<version>{{ .version }}</version>
<dependencies>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .parentArtifactId }}-common</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-common</artifactId>
</dependency>
<dependency>
<groupId>{{ .groupId }}</groupId>
<artifactId>{{ .artifactId }}-manager</artifactId>
</dependency>
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
</dependency>
</dependencies>
</project>

1
template/service/readme.md Normal file
View File

@@ -0,0 +1 @@
## 具体业务逻辑层定义，包括对api等实现，以Servcie为后缀

4
template/service/src/main/java/{{.packagePath}}/service/base/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放BaseServiceImpl
```
\-- *BaseServiceImpl.java
```

4
template/service/src/main/java/{{.packagePath}}/service/converter/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放Converter
```
\-- *Converter.java
```

4
template/service/src/main/java/{{.packagePath}}/service/dto/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放DTO
```
\-- *DTO.java
```

4
template/service/src/main/java/{{.packagePath}}/service/utils/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放工具类
```
\-- *Util.java
```

4
template/service/src/test/java/{{.packagePath}}/service/README.md Normal file
View File

@@ -0,0 +1,4 @@
存放Test
```
\-- *Test.java
```

11
values.yml Normal file
View File

@@ -0,0 +1,11 @@
moduleName: his_to
groupId: com.volunteerBank
artifactId: '{{ .moduleName | replace "-" "_" }}'
parentArtifactId: '{{ .projectName | replace "-" "_" }}'
projectId: 5faf4e3e-48e6-44b1-a7c5-79a0312aabe4
moduleId: 27325654-a00a-44f1-a2db-245336f5b47e
version: 3.0-SNAPSHOT
package: "{{ .groupId }}.{{ .artifactId }}"
packagePath: '{{ .package | replace "." "/" }}'
projectName: volunteer-bank
applicationName: "{{ .projectName }}-server"