maven聚合工程整合springboot+mybatisplus遇到的问题

2024-05-28 16:56
java, maven
28人已看

前言（可以直接跳过看下面解决方法）

项目结构

两个module：

yema-terminal-boot 是springboot项目，子包有：controller、service、dao 等等。属于经典三层架构。那么，该module可以理解为是一个单体项目，采用MVC软件设计模式+三层体系的编程思想构建而成

yema-common 的作用，就是存放一些公用的资源，任何公用的都放这里，除了常用自定义工具类，还包括接口！然后该module的pom.xml文件中定义了整个项目所需要的依赖jar包。这样做，yema-terminal-boot 的pom.xml中只需要依赖 yema-common 即可。

为什么这样设计两个module？

也许，市面上的Maven聚合工程，挺多人是这样弄的，比如：

yema-terminal-boot

yema-service

yema-dao

yema-common

这样也可以，就是有个问题。当我再次新建一个module作为另一个单体项目时，那么这个单体项目的业务层和持久层，都得写yema-service、yema-dao 中。当业务多了，项目经手的程序员多了，可能会出现乱调用现象。就是说yema-service 中的某个接口，其实是只服务于其中一个单体项目，另一个单体项目是不能用的。但是却调用了，虽然功能也实现了，但给以后埋下了个地雷。

而我目前这种只用两个module，就是为了强制规范。是这个项目的就这个项目里写，不要偷懒去复用。虽然工作量多了点，但以后排查与修改问题就好很多。（我就接手了这种项目，生产支付调用问题，发现多个springboot启动类调用到，头皮发麻，改一下，要测试多个项目）

整合

父pom.xml

<?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>

    <groupId>com.yema</groupId>
    <artifactId>YMRoot</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>yema-common</module>
        <module>yema-terminal-boot</module>
    </modules>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <!-- 继承说明：这里继承SpringBoot提供的父工程 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.yema</groupId>
                <artifactId>yema-common</artifactId>
                <version>1.0-SNAPSHOT</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

yema-terminal-boot的pom.xml

<?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">
    <parent>
        <artifactId>YMRoot</artifactId>
        <groupId>com.yema</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>yema-terminal-boot</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.yema</groupId>
            <artifactId>yema-common</artifactId>
        </dependency>
    </dependencies>

    <build>
        <finalName>ym-terminal-boot</finalName>
        <plugins>
            <plugin>
                <!--该插件主要用途：可执行的 JAR / WAR  -->
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

yema-terminal-boot的resources下的log4j2.xml

注意：需要在yml中配置。成功后，日志保存在该项目所在磁盘根目录下，实在找不到，全局搜XLogs目录

#配置日志
logging.level.com.yema: info
logging.config: classpath:log4j2.xml
logging.file.encoding: UTF-8

<?xml version="1.0" encoding="UTF-8"?>
<!--
configuration 节点的属性:
status:用来指定log4j本身的打印日志的级别.
monitorinterval:用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s.
-->
<!--
日志级别以及优先级排序（由高到低）: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL
-->

<configuration status="DEBUG" monitorinterval="60">
    <!--声明属性-->
    <Properties>
        <!--这里的log.path是定义日志存放的地方，此处是存放于项目根路径下的/sf.xlogs文件夹中-->
        <!--        <Property name="log.path">/sf.xlogs</Property>-->
        <!-- 格式化输出：%date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %msg：日志消息，%n是换行符-->
        <!-- %logger{36} 表示 Logger 名字最长36个字符    -->
        <property name="LOG_PATTERN" value="%date{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36}(%F:%L) - %msg%n" />
        <!-- 定义日志存储的路径 -->
        <property name="LOG_FILE_PATH" value="/XLogs/terminal" />
        <property name="FILE_NAME" value="terminalFile" />
    </Properties>

    <!--声明日志输出位置-->
    <Appenders>

        <!--
            Console节点用来定义输出到控制台的Appender
            name : 指定Appender的名字，用于Logger节点引用
            target : SYSTEM_OUT 或 SYSTEM_ERR,一般设置为:SYSTEM_OUT
            PatternLayout : 指定日志输出格式，默认为%m%n
        -->
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="${LOG_PATTERN}"/>  <!--[%d{HH:mm:ss:SSS}] [%p] [%t] - %l - %m%n-->
        </Console>


        <!--
            File节点用来定义输出到指定位置的文件
            name:指定Appender的名字.
　　　　　　　 fileName:指定输出日志的目的文件带全路径的文件名.
　　　　　　　 PatternLayout:输出格式，不设置默认为:%m%n.
        -->
        <File name="XLogs" fileName="${LOG_FILE_PATH}/xlogs.log"  append="false">
            <PatternLayout pattern="${LOG_PATTERN}"/>   <!--[%d{HH:mm:ss:SSS}] [%p] [%t] - %l - %m%n-->
            <!-- 控制台只输出info其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
        </File>


        <!--
           RollingFile 节点用来定义超过指定大小自动删除旧的创建新的的Appender
           name:指定Appender的名字.
           fileName:指定输出日志的目的文件带全路径的文件名.
           PatternLayout:输出格式，不设置默认为:%m%n.
           filePattern:指定新建日志文件的名称格式.
           Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
           ThresholdFilter : 日志过滤器（如果存在多个日志过滤器，则使用<Filters></Filters>包含住）
           TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am.
           SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.
           DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

           只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） DENY(拒绝)，NEUTRAL(中立)，ACCEPT(允许)
           该RollingFile的Filters 代表的意思是，只输出info级别的日志,【先拒绝日志，后接受日志】顺序不能颠倒

        <RollingFile name="RollingFile" fileName="${log.path}/spring-trade-rolling.log"
                     filePattern="${log.path}/logs/${date:yyyy-MM}/info-%d{yyyy-MM-dd}.log.zip">
            <Filters>
                <ThresholdFilter level="warn" onMatch="DENY" onMismatch="NEUTRAL"/>
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>

            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] [%t] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy modulate="true" interval="1"/>
            </Policies>
        </RollingFile>-->

        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${LOG_FILE_PATH}/info.log" filePattern="${LOG_FILE_PATH}/logs/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.zip">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy modulate="true" interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的warn及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileWarn" fileName="${LOG_FILE_PATH}/warn.log" filePattern="${LOG_FILE_PATH}/logs/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.zip">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy modulate="true" interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileError" fileName="${LOG_FILE_PATH}/error.log" filePattern="${LOG_FILE_PATH}/logs/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.zip">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy modulate="true" interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

    </Appenders>


    <!--
       Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出
              level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
              AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender.

　　　　Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。
              level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
              name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
              AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。
    -->




    <!--<Loggers>
        &lt;!&ndash;过滤掉spring和mybatis的一些无用的All,Trace,Debug级别的日志信息&ndash;&gt;
        <logger name="org.springframework" level="INFO"/>
        <logger name="com.spring" level="INFO"/>


        &lt;!&ndash;
            additivity设置成false:org.mybatis包下的日志,只会打印到LogFile的appender中,不会再打到Root中定义的appender中
            additivity设置成true或不设置:日志除了打到LogFile的appender中,还会打印到Root中定义的appender的中
         &ndash;&gt;
        <logger name="org.mybatis" level="INFO" additivity="false">
            <appender-ref ref="LogFile"/>
        </logger>

        &lt;!&ndash;level代表只输出info级别以上的日志&ndash;&gt;
        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFile"/>
        </root>
    </Loggers>-->

    <!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
    <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>

        <!--过滤掉spring和mybatis的一些无用的DEBUG信息
            监控系统信息   若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。-->
        <Logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>
        <logger name="com.spring" level="INFO"/>
        <logger name="org.mybatis" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>

        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="XLogs"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>

</configuration>

yema-common的pom.xml

<?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">
    <parent>
        <artifactId>YMRoot</artifactId>
        <groupId>com.yema</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>yema-common</artifactId>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions><!-- 去掉springboot默认配置 -->
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <!--引入log4j2启动日志打印-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
        <!--连接sqlserver-->
        <dependency>
            <groupId>com.microsoft.sqlserver</groupId>
            <artifactId>mssql-jdbc</artifactId>
            <scope>runtime</scope>
        </dependency>
        <!-- 以简单的注解形式来简化java代码，提高开发人员的开发效率。Lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--  json处理 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.73</version>
        </dependency>
        <!--  Apache工具包   -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>
        <!-- 配置阿里数据库连接池，要配置log4j12这个包，不然报错 start        -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.8</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
        </dependency>
        <!-- 配置阿里数据库连接池，要配置log4j12这个包，不然报错 end        -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.25</version>
        </dependency>
        <!--   mybatisplus 持久层框架 start     -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.3.2</version>
        </dependency>
        <!-- 配置分页乐观锁插件时需要 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-extension</artifactId>
            <version>3.4.2</version>
        </dependency>
        <!--   mybatisplus 持久层框架 end     -->

        <!-- JSON Web Token（JWT）库 start-->
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt-api</artifactId>
            <version>0.11.5</version>
        </dependency>
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt-impl</artifactId>
            <version>0.11.5</version>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt-jackson</artifactId>
            <version>0.11.5</version>
            <scope>runtime</scope>
        </dependency>
        <!-- JSON Web Token（JWT）库 end-->

        <!-- 第三方get post请求  start     -->
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
            <version>4.5.13</version> <!-- 根据需要使用最新版本 -->
        </dependency>
        <dependency>
            <groupId>org.apache.httpcomponents.client5</groupId>
            <artifactId>httpclient5</artifactId>
            <version>5.2.3</version>
        </dependency>
        <!-- 第三方get post请求  end     -->
        <!-- 文件传输 -->
        <dependency>
            <groupId>com.sun.jersey</groupId>
            <artifactId>jersey-client</artifactId>
            <version>1.19.4</version>
        </dependency>

        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>2.11.0</version>
        </dependency>

        <dependency>
            <groupId>net.coobird</groupId>
            <artifactId>thumbnailator</artifactId>
            <version>0.4.8</version>
        </dependency>

        <!--百度人脸识别-->
        <dependency>
            <groupId>com.baidu.aip</groupId>
            <artifactId>java-sdk</artifactId>
            <version>4.12.0</version>
        </dependency>

    </dependencies>
</project>

整合遇到的问题

1、Invalid bound statement (not found)

（前提是首先你得排查下注解以及扫描以及mapper.xml中的namespace引用是否正确）

这是没有扫描到对应的mapper.xml。原因是mybatis-plus 3.1.2 版本后，里面已经设置默认扫描位置为：classpath*:mapper/**/*.xml，见配置文件：MybatisPlusProperties

所以在springboot的yml中要配置成

mybatis-plus:
  mapper-locations: classpath*:mapper/*.xml
  type-aliases-package: com.yema
  configuration:
    log-impl: org.apache.ibatis.logging.log4j2.Log4j2Impl #开启sql日志
    #    log-impl: org.apache.ibatis.logging.nologging.NoLoggingImpl #关闭sql日志
    default-enum-type-handler: com.baomidou.mybatisplus.extension.handlers.MybatisEnumTypeHandler
    call-setters-on-nulls: true #设置值为null时字段也返回给前端
    cache-enabled: true #开启缓存
    lazy-loading-enabled: true #开启懒加载
    aggressive-lazy-loading: false #关闭立即加载
    jdbc-type-for-null: null #因为mybatis对所有的null都映射的是原生Jdbc的OTHER类型，oracle不能正确处理，所以修改jdbcTypeForNull的值为null
    map-underscore-to-camel-case: true #开启驼峰转换，就是数据库的字段是student_id 对应 实体类属性 studentId

2、Maven打包后没有没有BOOT-INF等目录

原因是在springboot对应的module（yema-terminal-boot）的pom.xml中缺少

<build>
        <finalName>ym-terminal-boot</finalName>
        <plugins>
            <plugin>
                <!--该插件主要用途：可执行的 JAR / WAR  -->
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>