IDEA mybatisplus 代码生成器的配置

时间:2024-11-13 07:30:34

mybatisplus项目结构图
在这里插入图片描述
效果图
在这里插入图片描述
BaseController控制器

package cn.cxyxmg.mybatisplus.common.base;

public class BaseController {
}

CodeGenerator控制器/运行此控制器即可生成/
CodeGenerator是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。

package cn.cxyxmg.mybatisplus.common.generator;

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

public class CodeGenerator {

    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + ":");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "!");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("cxyxmg");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/demo?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai&zeroDateTimeBehavior=CONVERT_TO_NULL");
        // ("public");
        dsc.setDriverName("");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("system");
        pc.setParent("");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        // String templatePath = "/templates/";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
       /* (new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
                return projectPath + "/src/main/resources/mapper/" + ()
                        + "/" + () + "Mapper" + StringPool.DOT_XML;
            }
        });*/
        /*
        (new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录");
                return false;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // ("templates/");
        // ();
        // ();

        //(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // ("");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        strategy.setSuperControllerClass("");
        // 写于父类中的公共字段
        // ("id");
        //输入表名,生成实体类,不写默认生成数据库所有的表
        strategy.setInclude("user");
        strategy.setControllerMappingHyphenStyle(true);
        // (() + "_");
        mpg.setStrategy(strategy);
        // (new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

配置

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="/POM/4.0.0" xmlns:xsi="http:///2001/XMLSchema-instance"
  xsi:schemaLocation="/POM/4.0.0 /xsd/maven-4.0.">
  <modelVersion>4.0.0</modelVersion>

  <groupId></groupId>
  <artifactId>mybatisplus</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>mybatisplus Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url></url>

  <properties>
    <>UTF-8</>
    <>1.8</>
    <>1.8</>
  </properties>

  <dependencies>
    <dependency>
      <groupId></groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.1.</version>
    </dependency>

    <!-- /artifact//spring-context -->
    <dependency>
      <groupId></groupId>
      <artifactId>spring-context</artifactId>
      <version>5.1.</version>
    </dependency>

    <!-- /artifact//spring-jdbc -->
    <dependency>
      <groupId></groupId>
      <artifactId>spring-jdbc</artifactId>
      <version>5.1.</version>
    </dependency>

    <!-- /artifact//spring-aspects -->
    <dependency>
      <groupId></groupId>
      <artifactId>spring-aspects</artifactId>
      <version>5.1.</version>
    </dependency>

    <!-- /artifact//mybatis-spring -->
    <dependency>
      <groupId></groupId>
      <artifactId>mybatis-spring</artifactId>
      <version>2.0.1</version>
    </dependency>

    <!-- /artifact/mysql/mysql-connector-java -->
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>8.0.16</version>
    </dependency>

    <dependency>
      <groupId></groupId>
      <artifactId>spring-test</artifactId>
      <version>5.1.</version>
    </dependency>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>compile</scope>
    </dependency>

    <!-- /artifact//lombok -->
    <dependency>
      <groupId></groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.8</version>
      <scope>provided</scope>
    </dependency>

    <dependency>
      <groupId></groupId>
      <artifactId>jna</artifactId>
      <version>3.0.9</version>
    </dependency>

    <!-- /artifact//fastjson -->
    <dependency>
      <groupId></groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.58</version>
    </dependency>

    <dependency>
      <groupId></groupId>
      <artifactId>mybatis-plus</artifactId>
      <version>3.1.2</version>
    </dependency>

    <!-- 添加 代码生成器 依赖 -->
    <dependency>
      <groupId></groupId>
      <artifactId>mybatis-plus-generator</artifactId>
      <version>3.1.2</version>
    </dependency>
    <!-- 添加 模板引擎 依赖 -->
    <dependency>
      <groupId></groupId>
      <artifactId>velocity-engine-core</artifactId>
      <version>2.1</version>
    </dependency>

    <dependency>
      <groupId></groupId>
      <artifactId>HikariCP</artifactId>
      <version>3.3.1</version>
    </dependency>
  </dependencies>

  <build>
    <finalName>mybatisplus</finalName>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see /ref/current/maven-core/#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
    <resources>
      <!--编译之后包含xml-->
      <resource>
        <directory>src/main/java</directory>
        <includes>
          <include>**/*.xml</include>
        </includes>
        <filtering>true</filtering>
      </resource>
    </resources>
  </build>
</project>

配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http:///2001/XMLSchema-instance"
         xmlns="/xml/ns/javaee"
         xsi:schemaLocation="/xml/ns/javaee
     /xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
  <display-name>mybatisplus</display-name>

  <!-- 配置编码方式过滤器,注意一点:要配置在所有过滤器的前面 (解决post请求乱码问题) -->
  <filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filter-class></filter-class>
    <init-param>
      <param-name>encoding</param-name>
      <param-value>utf-8</param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

  <!-- 加载spring相关配置 -->
  <context-param>
    <param-name>contextConfigLocation</param-name>
    <!-- 这里使用的是以spring*.xml的通配符方式加载配置的 -->
    <param-value>classpath:</param-value>
  </context-param>

  <listener>
    <listener-class></listener-class>
  </listener>

  <!-- 配置前端控制器DispatcherServlet -->
  <servlet>
    <servlet-name>springmvc</servlet-name>
    <servlet-class></servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <!-- 对应上一步创建全局配置文件的文件名以及目录 -->
      <param-value>classpath:</param-value>
    </init-param>
  </servlet>

  <!--
  第一种:*.do,访问以.do结尾由DispatcherServlet进行解析
  第二种:/, 所有访问的地址都由DispatcherServlet进行解析,对于静态文件的解析需要配置不让DispatcherServlet进行解析
  -->
  <servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <url-pattern>*.do</url-pattern>
  </servlet-mapping>

</web-app>

driverClassName=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3306/demo?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai&zeroDateTimeBehavior=CONVERT_TO_NULL
username=root
password=root

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-////DTD Config 3.0//EN"
        "/dtd/">
<configuration>

    <!--
    | 全局配置设置
    |
    | 可配置选项                   默认值,     描述
    |
    | aggressiveLazyLoading       true,     当设置为‘true’的时候,懒加载的对象可能被任何懒属性全部加载。否则,每个属性都按需加载。
    | multipleResultSetsEnabled   true,     允许和不允许单条语句返回多个数据集(取决于驱动需求)
    | useColumnLabel              true,     使用列标签代替列名称。不同的驱动器有不同的作法。参考一下驱动器文档,或者用这两个不同的选项进行测试一下。
    | useGeneratedKeys            false,    允许JDBC 生成主键。需要驱动器支持。如果设为了true,这个设置将强制使用被生成的主键,有一些驱动器不兼容不过仍然可以执行。
    | autoMappingBehavior         PARTIAL,  指定MyBatis 是否并且如何来自动映射数据表字段与对象的属性。PARTIAL将只自动映射简单的,没有嵌套的结果。FULL 将自动映射所有复杂的结果。
    | defaultExecutorType         SIMPLE,   配置和设定执行器,SIMPLE 执行器执行其它语句。REUSE 执行器可能重复使用prepared statements 语句,BATCH执行器可以重复执行语句和批量更新。
    | defaultStatementTimeout     null,     设置一个时限,以决定让驱动器等待数据库回应的多长时间为超时
    | -->
    <settings>
        <!-- 打印查询语句 -->
        <!-- <setting name="logImpl" value="STDOUT_LOGGING" /> -->
        <!-- 这个配置使全局的映射器启用或禁用缓存 -->
        <setting name="cacheEnabled" value="true"/>
        <!-- 全局启用或禁用延迟加载。当禁用时,所有关联对象都会即时加载 -->
        <!-- 查询时,关闭关联对象即时加载以提高性能 -->
        <setting name="lazyLoadingEnabled" value="true"/>
        <!-- 对于未知的SQL查询,允许返回不同的结果集以达到通用的效果 -->
        <setting name="multipleResultSetsEnabled" value="true"/>
        <!--是否开启自动驼峰命名规则(camel case)映射,即从经典数据库列名 A_COLUMN 到经典Java 属性名 aColumn 的类似映射。 -->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
        <setting name="useColumnLabel" value="true"/>
        <setting name="defaultExecutorType" value="REUSE"/>
        <setting name="defaultStatementTimeout" value="25000"/>
        <!-- 设置关联对象加载的形态,此处为按需加载字段(加载字段由SQL指 定),不会加载关联表的所有字段,以提高性能 -->
        <setting name="aggressiveLazyLoading" value="true"/>
    </settings>
</configuration>

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="/schema/beans"
       xmlns:context="/schema/context" xmlns:p="/schema/p"
       xmlns:aop="/schema/aop" xmlns:tx="/schema/tx"
       xmlns:xsi="http:///2001/XMLSchema-instance"
       xsi:schemaLocation="/schema/beans /schema/beans/spring-beans-4.
       /schema/context /schema/context/spring-context-4.
       /schema/aop /schema/aop/spring-aop-4. /schema/tx /schema/tx/spring-tx-4.
       /schema/util /schema/util/spring-util-4.">

    <!--开启spring注解,扫描spring注解所在的包 -->
    <context:component-scan base-package=""/>

    <!-- 加载资源文件 -->
    <bean class="">
        <!-- 配置资源文件 -->
        <property name="locations">
            <list>
                <value>classpath:</value>
            </list>
        </property>
    </bean>

    <!-- ========================================配置数据源========================================= -->
    <bean id="dataSource" class="">
        <property name="driverClassName" value="${driverClassName}"></property>
        <property name="jdbcUrl" value="${url}"></property>
        <property name="username" value="${username}"></property>
        <property name="password" value="${password}"></property>
        <property name="readOnly" value="false" />
        <property name="connectionTimeout" value="30000" />
        <property name="idleTimeout" value="600000" />
        <property name="maxLifetime" value="1800000" />
        <property name="maximumPoolSize" value="15" />
    </bean>

    <bean class="">
        <!-- 配置mapper接口所在路径,扫描路径下的所有的mapper接口  如果配置多个mapper的包,使用逗号进行分割 -->
        <!-- 在mybatis当中,dao层与mapper是一样的,只是不同地方叫法不一样,是写sql的,是用来操作数据库的 -->
        <property name="basePackage" value=".*.mapper"></property>
    </bean>
    <!-- spring整合Mybatis的配置,其实主要是mybatis的相应配置 -->
    <!-- sqlSession工厂 mapper的接口配置 -->
    <!-- SqlSessionFactory Config -->
    <bean id="sqlSessionFactory" class="">
        <property name="dataSource" ref="dataSource"/>
        <property name="mapperLocations" value="classpath:cn/cxyxmg/mybatisplus/**/mapper/xml/*.xml"/>
        <property name="globalConfig" ref="globalConfig"/>
        <property name="plugins">
            <array>
                <bean class=""></bean>
                <bean class=""></bean>
            </array>
        </property>
    </bean>
    <bean id="globalConfig" class="">
        <property name="dbConfig" ref="dbConfig"/>
    </bean>
    <bean id="dbConfig" class="">
        <property name="keyGenerator" ref="keyGenerator"/>
        <property name="logicDeleteValue" value="-1"></property>
        <property name="logicNotDeleteValue" value="0"></property>
    </bean>
    <bean id="keyGenerator" class=".H2KeyGenerator"/>
<!--    <bean  class="">
        <property name="dataSource" ref="dataSource" />
        &lt;!&ndash; 加载全局的配置文件 &ndash;&gt;
        <property name="configLocation" value="classpath:"></property>
        &lt;!&ndash; 配置mapper的扫描,找到所有的映射文件。编码时放开注释,如果放开需要在mapper中写一个mapper也是可以的 &ndash;&gt;
        &lt;!&ndash; <property name="mapperLocations" value="classpath:cn/cxyxmg/mybatisplus/**/mapper/xml/*.xml"></property> &ndash;&gt;
        &lt;!&ndash; 配置类型别名 &ndash;&gt;
        <property name="typeAliasesPackage" value=".*.entity"></property>
    </bean>-->

    <!-- 定义事务管理器 -->
    <bean id="transactionManager"
          class="">
        <property name="dataSource" ref="dataSource" />
    </bean>
    <!-- 定义事务策略 -->
    <tx:advice id="txAdvice" transaction-manager="transactionManager">
        <tx:attributes>
            <!--所有以query开头的方法都是只读的 -->
            <tx:method name="query*" read-only="true" />
            <tx:method name="get*" read-only="true" />
            <tx:method name="find*" read-only="true" />
            <tx:method name="select*" read-only="true" />
            <!--其他方法使用默认事务策略 -->
            <tx:method name="*" />
        </tx:attributes>
    </tx:advice>

    <aop:config>
        <!--pointcut元素定义一个切入点,execution中的第一个星号 用以匹配方法的返回类型,
        这里星号表明匹配所有返回类型。 .*.*(..)表明匹配包下的所有类的所有 
        方法 -->
        <aop:pointcut id="myPointcut" expression="execution(* .*.service.*.*(..))" />
        <!--将定义好的事务处理策略应用到上述的切入点 -->
        <aop:advisor advice-ref="txAdvice" pointcut-ref="myPointcut" />
    </aop:config>
</beans>

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="/schema/beans"
       xmlns:xsi="http:///2001/XMLSchema-instance"
       xmlns:mvc="/schema/mvc"
       xmlns:context="/schema/context"
       xsi:schemaLocation="
    	/schema/beans
        /schema/beans/spring-beans-4.
        /schema/mvc
        /schema/mvc/spring-mvc-4.
        /schema/context
        /schema/context/spring-context-4.">

    <!-- 解析包下的注解 -->
    <context:component-scan base-package=".*.controller"/>

    <!--
    会自动注册RequestMappingHandlerMapping、RequestMappingHandlerAdapter 与xceptionHandlerExceptionResolver 三个bean。
    如果没有<mvc:annotation-driven/>,那么所有的Controller可能就没有解析,所有当有请求时候都没有匹配的处理请求类,
    就都去<mvc:default-servlet-handler/>即default servlet处理了。添加上<mvc:annotation-driven/>后,相应的do请求被Controller处理,
    而静态资源因为没有相应的Controller就会被default servlet处理。总之没有相应的Controller就会被default servlet处理就ok了。
    -->
    <!-- 可代替下面处理映射器和处理器适配器 -->
     <mvc:annotation-driven>
        <!-- 解决REST风格返回数据乱码 -->
        <mvc:message-converters register-defaults="true">
            <bean class="">
                <constructor-arg value="UTF-8"></constructor-arg>
            </bean>
            <bean class="">
                <property name="supportedMediaTypes">
                    <list>
                        <value>text/html;charset=UTF-8</value>
                        <value>application/json</value>
                        <value>application/xml;charset=UTF-8</value>
                    </list>
                </property>
                <property name="features">
                    <list>
                        <!-- 默认的意思就是不配置这个属性,配置了就不是默认了 -->
                        <!-- 是否输出值为null的字段 ,默认是false-->
                        <value>WriteMapNullValue</value>
                        <value>WriteNullNumberAsZero</value>
                        <value>WriteNullListAsEmpty</value>
                        <value>WriteNullStringAsEmpty</value>
                        <value>WriteNullBooleanAsFalse</value>
                        <value>WriteDateUseDateFormat</value>
                    </list>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

    <!--<bean name="/" class=""></bean>-->

    <!-- 配置处理映射器将bean的name作为url进行查找,需要在配置Handle时指定name(即url) -->
    <!--<bean class=""/>-->

    <!-- 配置处理器适配器,所有处理适配器都要实现 HandlerAdapter接口-->
    <!--<bean class=""/>-->

    <!-- 配置视图解析器 解析jsp视图,默认使用jstl标签 CLASSPATH下面要有jstl jar包 -->
<!--    <bean class="" >
        &lt;!&ndash; 前缀 &ndash;&gt;
        <property name="prefix" value="/WEB-INF/views/" />
        &lt;!&ndash; 后缀 &ndash;&gt;
        <property name="suffix" value=".jsp" />
    </bean> -->

</beans>