git地址： https://github.com/leezhang0525/boot
branch：1.1.0mysql
本文档持续更新，目标为多组件系统，常用组件集成完毕后，后续会添加分布式内容。

一、新建dao模块

image.png
image.png
依次添加 service、common、entity等模块
image.png

二、添加依赖

这里只展示了 父模块和 web、dao模块的 pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.         <version>2.6.6</version>
  9.         <relativePath/>
  10.     </parent>
  12.     <modelVersion>4.0.0</modelVersion>
  14.     <groupId>com.zhangsan.boot</groupId>
  15.     <artifactId>boot</artifactId>
  16.     <version>1.0-SNAPSHOT</version>
  18.     <packaging>pom</packaging>
  19.     <name>boot</name>
  20.     <description>boot</description>
  22.     <modules>
  23.         <module>web</module>
  24.         <module>dao</module>
  25.         <module>service</module>
  26.         <module>service-impl</module>
  27.         <module>entity</module>
  28.         <module>dto</module>
  29.         <module>common</module>
  30.     </modules>
  32.     <properties>
  33.         <java.version>1.8</java.version>
  34.         <mybatis.version>2.2.2</mybatis.version>
  35.         <mysql-connector.version>8.0.28</mysql-connector.version>
  36.         <druid.version>1.1.10</druid.version>
  37.         <fastjson.version>1.2.60</fastjson.version>
  38.     </properties>
  40.     <dependencyManagement>
  41.         <dependencies>
  42.             <dependency>
  43.                 <groupId>mysql</groupId>
  44.                 <artifactId>mysql-connector-java</artifactId>
  45.                 <version>${mysql-connector.version}</version>
  46.             </dependency>
  47.             <dependency>
  48.                 <groupId>org.mybatis.spring.boot</groupId>
  49.                 <artifactId>mybatis-spring-boot-starter</artifactId>
  50.                 <version>${mybatis.version}</version>
  51.             </dependency>
  52.             <dependency>
  53.                 <groupId>com.alibaba</groupId>
  54.                 <artifactId>fastjson</artifactId>
  55.                 <version>${fastjson.version}</version>
  56.             </dependency>
  57.             <dependency>
  58.                 <groupId>com.alibaba</groupId>
  59.                 <artifactId>druid-spring-boot-starter</artifactId>
  60.                 <version>${druid.version}</version>
  61.             </dependency>
  62.         </dependencies>
  63.     </dependencyManagement>
  65. </project>
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  6.     <parent>
  7.         <groupId>com.zhangsan.boot</groupId>
  8.         <artifactId>boot</artifactId>
  9.         <version>1.0-SNAPSHOT</version>
  10.     </parent>
  12.     <artifactId>web</artifactId>
  14.     <dependencies>
  15.         <dependency>
  16.             <groupId>com.zhangsan.boot</groupId>
  17.             <artifactId>service-impl</artifactId>
  18.             <version>1.0-SNAPSHOT</version>
  19.         </dependency>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-web</artifactId>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-jdbc</artifactId>
  27.         </dependency>
  28.         <dependency>
  29.             <groupId>org.mybatis.spring.boot</groupId>
  30.             <artifactId>mybatis-spring-boot-starter</artifactId>
  31.         </dependency>
  32.         <dependency>
  33.             <groupId>mysql</groupId>
  34.             <artifactId>mysql-connector-java</artifactId>
  35.         </dependency>
  36.         <dependency>
  37.             <groupId>com.alibaba</groupId>
  38.             <artifactId>druid-spring-boot-starter</artifactId>
  39.         </dependency>
  40.         <dependency>
  41.             <groupId>org.projectlombok</groupId>
  42.             <artifactId>lombok</artifactId>
  43.         </dependency>
  44.         <dependency>
  45.             <groupId>org.springframework.boot</groupId>
  46.             <artifactId>spring-boot-starter-test</artifactId>
  47.         </dependency>
  48.     </dependencies>
  49.     <build>
  50.         <plugins>
  51.             <plugin>
  52.                 <groupId>org.springframework.boot</groupId>
  53.                 <artifactId>spring-boot-maven-plugin</artifactId>
  54.                 <configuration>
  55.                     <excludes>
  56.                         <exclude>
  57.                             <groupId>org.projectlombok</groupId>
  58.                             <artifactId>lombok</artifactId>
  59.                         </exclude>
  60.                     </excludes>
  61.                 </configuration>
  62.             </plugin>
  63.         </plugins>
  64.     </build>
  66. </project>
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <artifactId>boot</artifactId>
  7.         <groupId>com.zhangsan.boot</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>dao</artifactId>
  13.     <dependencies>
  14.         <dependency>
  15.             <groupId>com.zhangsan.boot</groupId>
  16.             <artifactId>entity</artifactId>
  17.             <version>1.0-SNAPSHOT</version>
  18.         </dependency>
  20.         <dependency>
  21.             <groupId>mysql</groupId>
  22.             <artifactId>mysql-connector-java</artifactId>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.mybatis.spring.boot</groupId>
  26.             <artifactId>mybatis-spring-boot-starter</artifactId>
  27.         </dependency>
  28.         <dependency>
  29.             <groupId>com.alibaba</groupId>
  30.             <artifactId>druid-spring-boot-starter</artifactId>
  31.         </dependency>
  32.         <dependency>
  33.             <groupId>org.springframework.boot</groupId>
  34.             <artifactId>spring-boot-starter-jdbc</artifactId>
  35.         </dependency>
  36.     </dependencies>
  39. </project>

三、添加实体及mapper文件

这里使用mybatis-generator-maven-plugin 插件生成

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <artifactId>boot</artifactId>
  7.         <groupId>com.zhangsan.boot</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>generator</artifactId>
  14.     <build>
  15.         <plugins>
  16.             <plugin>
  17.                 <groupId>org.mybatis.generator</groupId>
  18.                 <artifactId>mybatis-generator-maven-plugin</artifactId>
  19.                 <version>1.3.7</version>
  20.                 <executions>
  21.                     <execution>
  22.                         <id>Generate MyBatis Artifacts</id>
  23.                         <goals>
  24.                             <goal>generate</goal>
  25.                         </goals>
  26.                     </execution>
  27.                 </executions>
  28.                 <!-- mvn mybatis-generator:generate -->
  29.                 <configuration>
  30.                     <configurationFile>./src/main/resources/mybatis-generator.xml</configurationFile>
  31.                     <overwrite>true</overwrite>
  32.                     <includeAllDependencies>true</includeAllDependencies>
  33.                 </configuration>
  34.             </plugin>
  36.         </plugins>
  37.     </build>
  38. </project>

resources目录下添加两个文件
image.png

  1. #本地mysql-connector-java-xx.jar路径
  2. drive.class.path=D:/file/maven_repo/mysql/mysql-connector-java/8.0.21/mysql-connector-java-8.0.21.jar
  3. jdbc.driver=com.mysql.jdbc.Driver
  4. jdbc.url=jdbc:mysql://localhost:3306/pay?serverTimezone=UTC
  5. jdbc.username=root
  6. jdbc.password=123456
  9. entity.package=com.zhangsan.boot.entity
  10. dao.package=com.zhangsan.boot.dao
  11. xml.mapper.package=/resources/mappers
  12. dao.target.project=D:/file/githubRepository/boot/dao/src/main/java
  13. xml.target.project=D:/file/githubRepository/boot/dao/src/main
  14. entity.target.project=D:/file/githubRepository/boot/entity/src/main/java
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE generatorConfiguration
  3.         PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
  6. <generatorConfiguration>
  7.     <!-- 配置文件路径 -->
  8.     <properties resource="generatorConfig.properties"/>
  9.     <!--数据库驱动包路径 -->
  10.     <classPathEntry location="${drive.class.path}"/>
  11.     <!--
  12.            context:生成一组对象的环境
  13.            id:必选，上下文id，用于在生成错误时提示
  14.            defaultModelType:指定生成对象的样式
  15.                1，conditional：类似hierarchical；
  16.                2，flat：所有内容（主键，blob）等全部生成在一个对象中；
  17.                3，hierarchical：主键生成一个XXKey对象(key class)，Blob等单独生成一个对象，其他简单属性在一个对象中(record class)
  18.            targetRuntime:
  19.                1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample；
  20.                2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample；
  21.            introspectedColumnImpl：类全限定名，用于扩展MBG
  22.        -->
  23.     <context id="MySQLTables" targetRuntime="MyBatis3">
  24.         <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；
  25.             一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖
  26.          -->
  27.         <property name="autoDelimitKeywords" value="false"/>
  28.         <!-- 生成的Java文件的编码 -->
  29.         <property name="javaFileEncoding" value="UTF-8"/>
  30.         <!-- 格式化java代码 -->
  31.         <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
  32.         <!-- 格式化XML代码 -->
  33.         <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
  35.         <!-- 不生成注释 -->
  36.         <commentGenerator>
  37. <!--            <property name="suppressAllComments" value="true"/>-->
  38.             <property name="suppressDate" value="true"/>
  39.         </commentGenerator>
  41.         <!--数据库连接信息 -->
  42.         <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
  43.         <!--<property name="beginningDelimiter" value="`"/>-->
  44.         <!--<property name="endingDelimiter" value="`"/>-->
  45.         <!-- 必须要有的，使用这个配置链接数据库
  46.             @TODO:是否可以扩展
  47.          -->
  48.         <jdbcConnection driverClass="${jdbc.driver}" connectionURL="${jdbc.url}" userId="${jdbc.username}"
  49.                         password="${jdbc.password}">
  50.         </jdbcConnection>
  52.         <!-- java类型处理器
  53.             用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl；
  54.             注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型；
  55.         -->
  56.         <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
  57.             <!--
  58.                 true：使用BigDecimal对应DECIMAL和 NUMERIC数据类型
  59.                 false：默认,
  60.                     scale>0;length>18：使用BigDecimal;
  61.                     scale=0;length[10,18]：使用Long；
  62.                     scale=0;length[5,9]：使用Integer；
  63.                     scale=0;length<5：使用Short；
  64.              -->
  65.             <property name="forceBigDecimals" value="false"/>
  66.         </javaTypeResolver>
  68.         <!--生成的model 包路径 -->
  69.         <javaModelGenerator targetPackage="${entity.package}" targetProject="${entity.target.project}">
  70.             <!--  for MyBatis3/MyBatis3Simple
  71.                 自动为每一个生成的类创建一个构造方法，构造方法包含了所有的field；而不是使用setter；
  72.              -->
  73.             <!--<property name="constructorBased" value="false"/>-->
  74.             <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
  75.             <property name="enableSubPackages" value="false"/>
  76.             <!-- for MyBatis3 / MyBatis3Simple
  77.                 是否创建一个不可变的类，如果为true，
  78.                 那么MBG会创建一个没有setter方法的类，取而代之的是类似constructorBased的类
  79.                 <property name="immutable" value="false"/>
  80.                  设置一个根对象，如果设置了这个根对象，那么生成的keyClass或者recordClass会继承这个类；在Table的rootClass属性中可以覆盖该选项
  81.                 注意：如果在key class或者record class中有root class相同的属性，MBG就不会重新生成这些属性了，包括：
  82.                     1，属性名相同，类型相同，有相同的getter/setter方法；
  83.                     <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>
  84.             -->
  85.             <!-- 设置是否在getter方法中，对String类型字段调用trim()方法 -->
  86.             <property name="trimStrings" value="true"/>
  87.         </javaModelGenerator>
  89.         <!-- 生成SQL map的XML文件生成器，
  90.             注意，在Mybatis3之后，我们可以使用mapper.xml文件+Mapper接口（或者不用mapper接口），
  91.                 或者只使用Mapper接口+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的话，这个元素就必须配置
  92.             targetPackage/targetProject:同javaModelGenerator
  93.          -->
  94.         <sqlMapGenerator targetPackage="${xml.mapper.package}" targetProject="${xml.target.project}">
  95.             <property name="enableSubPackages" value="ture"/>
  96.         </sqlMapGenerator>
  98.         <!-- 生成的Dao接口 的包路径 -->
  99.         <javaClientGenerator type="XMLMAPPER" targetPackage="${dao.package}" targetProject="${dao.target.project}">
  100.             <property name="enableSubPackages" value="ture"/>
  101.         </javaClientGenerator>
  103.         <!--
  104.            选择一个table来生成相关文件，可以有一个或多个table，必须要有table元素
  105.            选择的table会生成一下文件：
  106.            1，SQL map文件
  107.            2，生成一个主键类；
  108.            3，除了BLOB和主键的其他字段的类；
  109.            4，包含BLOB的类；
  110.            5，一个用户生成动态查询的条件类（selectByExample, deleteByExample），可选；
  111.            6，Mapper接口（可选）
  112.            tableName（必要）：要生成对象的表名；
  113.            注意：大小写敏感问题。正常情况下，MBG会自动的去识别数据库标识符的大小写敏感度，在一般情况下，MBG会
  114.                根据设置的schema，catalog或tablename去查询数据表，按照下面的流程：
  115.                1，如果schema，catalog或tablename中有空格，那么设置的是什么格式，就精确的使用指定的大小写格式去查询；
  116.                2，否则，如果数据库的标识符使用大写的，那么MBG自动把表名变成大写再查找；
  117.                3，否则，如果数据库的标识符使用小写的，那么MBG自动把表名变成小写再查找；
  118.                4，否则，使用指定的大小写格式查询；
  119.            另外的，如果在创建表的时候，使用的""把数据库对象规定大小写，就算数据库标识符是使用的大写，在这种情况下也会使用给定的大小写来创建表名；
  120.            这个时候，请设置delimitIdentifiers="true"即可保留大小写格式；
  121.            可选：
  122.            1，schema：数据库的schema；
  123.            2，catalog：数据库的catalog；
  124.            3，alias：为数据表设置的别名，如果设置了alias，那么生成的所有的SELECT SQL语句中，列名会变成：alias_actualColumnName
  125.            4，domainObjectName：生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字；可以设置为somepck.domainName，那么会自动把domainName类再放到somepck包里面；
  126.            5，enableInsert（默认true）：指定是否生成insert语句；
  127.            6，enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句（就是getById或get）；
  128.            7，enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句；
  129.            8，enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句（即update)；
  130.            9，enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句（即delete）；
  131.            10，enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句；
  132.            11，enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）；
  133.            12，enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）；
  134.            13，modelType：参考context元素的defaultModelType，相当于覆盖；
  135.            14，delimitIdentifiers：参考tableName的解释，注意，默认的delimitIdentifiers是双引号，如果类似MYSQL这样的数据库，使用的是`（反引号，那么还需要设置context的beginningDelimiter和endingDelimiter属性）
  136.            15，delimitAllColumns：设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false，delimitIdentifiers参考context的属性
  137.            注意，table里面很多参数都是对javaModelGenerator，context等元素的默认属性的一个复写；
  138.         -->
  140.         <!-- 实体表配置，需要导出哪些表就配哪些 -->
  141.         <table schema="root" tableName="tf_settle_notify_event"
  142.                enableCountByExample="false"
  143.                enableUpdateByExample="false"
  144.                enableDeleteByExample="false"
  145.                enableSelectByExample="false"
  146.                selectByExampleQueryId="false" >
  147.         </table>
  149.     </context>
  150. </generatorConfiguration>

四、编写application.yml文件

  1. server:
  2.   port: 8081
  3. spring:
  4.   datasource:
  5.     url: jdbc:mysql://localhost:3306/pay?characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&useLocalSessionState=true
  6.     username: root
  7.     password: 123456
  8.     driver-class-name: com.mysql.jdbc.Driver
  9.     type: com.alibaba.druid.pool.DruidDataSource

五、编写数据源

dao模块下添加config包后添加DruidConfig.java文件

  1. package com.zhangsan.boot.config;
  3. import com.alibaba.druid.pool.DruidDataSource;
  4. import org.apache.ibatis.session.SqlSessionFactory;
  5. import org.mybatis.spring.SqlSessionFactoryBean;
  6. import org.mybatis.spring.mapper.MapperScannerConfigurer;
  7. import org.springframework.beans.factory.annotation.Qualifier;
  8. import org.springframework.boot.context.properties.ConfigurationProperties;
  9. import org.springframework.context.annotation.Bean;
  10. import org.springframework.context.annotation.Configuration;
  11. import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
  12. import org.springframework.core.io.support.ResourcePatternResolver;
  14. import javax.sql.DataSource;
  16. @Configuration
  17. public class DruidConfig {
  19.     public static final String MAPPER_BASE_PACKAGE = "com.zhangsan.boot.dao";
  20.     public static final String ENTITY_BASE_PACKAGE = "com.zhangsan.boot.entity";
  22.     /**
  23.      * 数据源
  24.      * @return
  25.      */
  26.     @Bean
  27.     @ConfigurationProperties(prefix = "spring.datasource")
  28.     public DataSource dataSource(){
  29.         return new DruidDataSource();
  30.     }
  32.     /**
  33.      * SqlSessionFactory
  34.      * @param dataSource
  35.      * @return
  36.      * @throws Exception
  37.      */
  38.     @Bean
  39.     public SqlSessionFactory sqlSessionFactory (@Qualifier("dataSource") DataSource dataSource) throws Exception {
  40.         SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
  41.         sqlSessionFactoryBean.setDataSource(dataSource);
  42.         sqlSessionFactoryBean.setTypeAliasesPackage(ENTITY_BASE_PACKAGE);
  43.         ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
  44.         sqlSessionFactoryBean.setMapperLocations(resolver.getResources("classpath*:mappers/*.xml"));
  45.         return sqlSessionFactoryBean.getObject();
  46.     }
  48.     /**
  49.      * mapperScannerConfigurer
  50.      * @return
  51.      */
  52.     @Bean
  53.     public static MapperScannerConfigurer mapperScannerConfigurer() {
  54.         MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
  55.         mapperScannerConfigurer.setBasePackage(MAPPER_BASE_PACKAGE);
  56.         mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory");
  57.         return mapperScannerConfigurer;
  58.     }
  59. }

六、编写测试controller测试查询数据库

  1. @RestController
  2. @Slf4j
  3. public class TestController {
  5.     @GetMapping("/test")
  6.     public String test(){
  7.         log.info("这是测试");
  8.         return "success";
  9.     }
  11.     @Autowired
  12.     private PadDeviceService padDeviceService;
  14.     @GetMapping("/sqlTest")
  15.     public TPadDevice sqlTest(Long id){
  16.         log.info("这是测试");
  17.         TPadDevice padDevice = padDeviceService.getById(id);
  18.         return padDevice;
  19.     }
  20. }

注：WebApplication 启动类默认只加载同级目录下的bean，所以多模块场景下需要手动指定包扫描路径，让@SpringBootApplication 管理到项目中所有需要加载的bean
1650548354(1).png
1650548112(1).png