您的位置: 首页  >  文章  >  mybatis三大插件使用方法

mybatis三大插件使用方法

分类: 文章 • 2025-01-16 13:28:04

使用Intellij Idea2016.3.1+Maven3.3.9。

一、mybatis-generator的使用

作用：根据数据库自动生成pojo、dao和xml文件。

1、引入mybatis-generator

pom.xml中引入配置：lain copy
  1. <build>  
  2.     <finalName>MMall</finalName>  
  3.     <plugins>  
  4.       <plugin>  
  5.         <groupId>org.mybatis.generator</groupId>  
  6.         <artifactId>mybatis-generator-maven-plugin</artifactId>  
  7.         <version>1.3.2</version>  
  8.         <configuration>  
  9.           <!--允许移动生成的文件-->  
  10.           <verbose>true</verbose>  
  11.           <!--允许覆盖生成的文件-->  
  12.           <overwrite>true</overwrite>  
  13.         </configuration>  
  14.       </plugin>  
  15.     </plugins>  
  16.   </build>  
添加完后，在Maven Projects的Plugins中会多出一个mybatis-generator，如图：
mybatis三大插件使用方法
双击mybaitis-generator:generate，执行生成代码操作，控制台会提示BUILD FAILURE。
原因如下：
[html] view plain copy
  1. [ERROR] Failed to execute goal org.mybatis.generator:mybatis-generator-maven-plugin:1.3.2:  
[html] view plain copy
  1. generate (default-cli) on project MMall:   
[html] view plain copy
  1. configfile C:\Users\Administrator\Desktop\MMall\src\main\resources\generatorConfig.xml  
[html] view plain copy
  1. does not exist -> [Help 1]  
提示我们generatorConfig.xml这个文件不存在。

2、引入generatorConfig.xml配置

新建方法：在resources处右击选择New——>mybatis-generator-config，如图
mybatis三大插件使用方法
填写finaname为：generatorConfig，生成代码，并修改：

[html] view plain copy
  1. <?xml version="1.0" encoding="UTF-8" ?>  
  2. <!DOCTYPE generatorConfiguration PUBLIC  
  3.         "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"  
  4.         "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >  
  5. <generatorConfiguration>  
  6.     <!--导入属性配置-->  
  7.     <properties resource="db.properties"></properties>  
  8.     <!-- 指定特定数据库的jdbc驱动jar包的位置 -->  
  9.     <classPathEntry location="${db.driverLocation}"/>  
  10.     <!--  
  11.         context:至少需要有一个<context>元素,用于指定一组对象的环境。  
  12.         必选属性：id：用来确定一个<context>元素  
  13.         可选属性：  
  14.         1、defaultModelType：**这个属性很重要**，这个属性定义了MBG如何生成**实体类**。  
  15.   
  16.             conditional 默认属性，这个模型和下面的hierarchical类似，除了如果那个单独的类将只包含一个字段，  
  17.                         将不会生成一个单独的类。因此,如果一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,  
  18.                         将该字段合并到基本实体类中。  
  19.             flat：该模型为每一张表只生成一个实体类。这个实体类包含表中的所有字段。**这种模型最简单，推荐使用。  
  20.             hierarchical：如果表有主键,那么该模型会产生一个单独的主键实体类,如果表还有BLOB字段，  
  21.                         则会为表生成一个包含所有BLOB字段的单独的实体类,  
  22.                        然后为所有其他的字段生成一个单独的实体类。 MBG会在所有生成的实体类之间维护一个继承关系。  
  23.         2、targetRuntime：:此属性用于指定生成的代码的运行时环境。一般使用默认值即可。  
  24.                 MyBatis3:*这是默认值*  
  25.                 MyBatis3Simple  
  26.                 Ibatis2Java2  
  27.                 Ibatis2Java5  
  28.     -->  
  29.     <context id="context" defaultModelType="conditional" targetRuntime="MyBatis3">  
  30.         <!--旨在创建class时，对注释进行控制-->  
  31.         <commentGenerator>  
  32.             <!--suppressAllComments  false时打开注释，true时关闭注释-->  
  33.             <property name="suppressAllComments" value="false"/>  
  34.             <!--suppressDate  false时打开时间标志，true时关闭-->  
  35.             <property name="suppressDate" value="true"/>  
  36.         </commentGenerator>  
  37.   
  38.         <!--jdbc的数据库连接 -->  
  39.         <jdbcConnection driverClass="${db.driverClass}"  
  40.                         connectionURL="${db.url}"  
  41.                         userId="${db.username}"  
  42.                         password="${db.password}"/>  
  43.         <!--java类型处理器  
  44.             用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl；  
  45.             注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型；  
  46.         -->  
  47.         <javaTypeResolver>  
  48.             <!--  
  49.             true：使用BigDecimal对应DECIMAL和 NUMERIC数据类型  
  50.             false：默认,  
  51.                 scale>0;length>18：使用BigDecimal;  
  52.                 scale=0;length[10,18]：使用Long；  
  53.                 scale=0;length[5,9]：使用Integer；  
  54.                 scale=0;length<5：使用Short；  
  55.             -->  
  56.             <property name="forceBigDecimals" value="true"/>  
  57.         </javaTypeResolver>  
  58.         <!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类  
  59.             targetPackage     指定生成的model生成所在的包名  
  60.             targetProject     指定在该项目下所在的路径  
  61.         -->  
  62.         <javaModelGenerator targetPackage="com.mmall.entity"  
  63.                             targetProject="src/main/java">  
  64.             <!-- 是否允许子包，即targetPackage.schemaName.tableName -->  
  65.             <property name="enableSubPackages" value="false"/>  
  66.             <!-- 是否对model添加 构造函数 -->  
  67.             <property name="constructorBased" value="true"/>  
  68.             <!-- 是否对类CHAR类型的列的数据进行trim操作 -->  
  69.             <property name="trimStrings" value="true"/>  
  70.             <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->  
  71.             <property name="immutable" value="false"/>  
  72.             <!-- 设置一个根对象，即基类-->  
  73.             <property name="rootClass" value="com.mmall.entity.BaseEntity"/>  
  74.         </javaModelGenerator>  
  75.   
  76.         <!--Mapper映射文件生成器  
  77.             targetPackage：指定生成的model生成所在的包名  
  78.             targetProject     指定在该项目下所在的路径  
  79.         -->  
  80.         <sqlMapGenerator targetPackage="com.mmall.dao"  
  81.                          targetProject="src/main/java">  
  82.             <!--是否允许子包，即targetPackage.schemaName.tableName-->  
  83.             <property name="enableSubPackages" value="false"/>  
  84.         </sqlMapGenerator>  
  85.         <!-- 对于mybatis来说，即生成Mapper接口  
  86.             targetPackage/targetProject:同javaModelGenerator  
  87.             type：选择怎么生成mapper接口（在MyBatis3/MyBatis3Simple下）：  
  88.                 1，ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），  
  89.                 不会生成对应的XML；  
  90.                 2，MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中；  
  91.                 3，XMLMAPPER：会生成Mapper接口，接口完全依赖XML；  
  92.             注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER  
  93.         -->  
  94.         <javaClientGenerator targetPackage="com.mmall.dao"  
  95.                              targetProject="src/main/java"  
  96.                              type="XMLMAPPER">  
  97.             <!--是否允许子包，即targetPackage.schemaName.tableName-->  
  98.             <property name="enableSubPackages" value="false"/>  
  99.         </javaClientGenerator>  
  100.   
  101.         <!--  
  102.             tableName:数据库表名  
  103.             domainObjectName:实体类名  
  104.             enableCountByExample（默认true）：MyBatis3Simple为false，  
  105.                 指定是否生成动态查询总条数语句（用于分页的总条数查询）；  
  106.             enableUpdateByExample：（默认true）：MyBatis3Simple为false，  
  107.                 指定是否生成动态修改语句（只修改对象中不为空的属性）；  
  108.             enableDeleteByExample：enableDeleteByExample（默认true）：  
  109.                 MyBatis3Simple为false，指定是否生成动态删除语句；  
  110.             enableSelectByExample：enableSelectByExample（默认true）：  
  111.                 MyBatis3Simple为false，指定是否生成动态查询语句；  
  112.             selectByExampleQueryId：  
  113.             enableInsert（默认true）：指定是否生成insert语句；  
  114.             enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句（就是getById或get）；  
  115.             enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句（即update)；  
  116.             enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句（即delete）；  
  117.             modelType：参考context元素的defaultModelType，相当于覆盖；  
  118.         -->  
  119.         <table tableName="t_good"  
  120.                domainObjectName="Good"  
  121.                enableCountByExample="false" enableUpdateByExample="false"  
  122.                enableDeleteByExample="false" enableSelectByExample="false"  
  123.                selectByExampleQueryId="false"/>  
  124.     </context>  
  125. </generatorConfiguration>  
db.properties内容如下：
[html] view plain copy
  1. db.driverLocation=D:\mysql-connector-java-5.1.7-bin.jar  
  2. db.driverClass=com.mysql.jdbc.Driver  
  3. db.url=jdbc:mysql://127.0.0.1:3306/girl?useUnicode=true&characterEncoding=utf-8&useSSL=false  
  4. db.username=root  
  5. db.password=  
重新执行mybaitis-generator:generate，控制台提示Build Success。

二、mybatis-plugin的使用

这是一个能够追踪dao 接口和mapper文件里xml的一个插件，包括
  • 编辑XML时自动补全
  • 根据Mapper接口，使用快捷键生成xml文件及SQL标签
  • ResultMap中的property支持自动补全
  • 快捷键生成@Param注解
  • XML中编辑SQL时, 括号自动补全
  • XML中编辑SQL时, 支持参数自动补全(基于@Param注解识别参数)
  • 自动检查Mapper XML文件中ID冲突
  • 自动检查Mapper XML文件中错误的属性值
  • 支持Find Usage
  • 支持重构从命名
  • 支持别名
  • 自动生成ResultMap属性
  • 快捷键: Alt + Enter(Windows)

1、安装插件

mybatis三大插件使用方法

右侧会有install按钮，点击安装重启idea 。

2、mybatis-plugin插件**

 点击打开链接进入根据插件版本下载相应包至本地。

找到本机的mybatis_plus.jar，位置为C:\Users\Administrator\.IntelliJIdea2016.3\config\plugins\mybatis_plus\lib。
使用解压工具打开
mybatis三大插件使用方法
将下载好的**，与plugin插件压缩包中的文件更换，拖入压缩包，更换就行 
mybatis三大插件使用方法
重启IDEA，**成功。
点击绿色小按钮可以进入xml文件
mybatis三大插件使用方法

三、mybatis-pagehelper的使用

它是一个开源的分页插件点击打开链接，它的原理，是通过spring的AOP来实现的，这个插件能在执行sql的时候，把相关的数据再执行一次。

1、在pom.xml中添加依赖

[html] view plain copy
  1. <dependency>  
  2.       <groupId>com.github.pagehelper</groupId>  
  3.       <artifactId>pagehelper</artifactId>  
  4.       <version>4.1.0</version>  
  5.     </dependency>  
  6.   
  7.     <dependency>  
  8.       <groupId>com.github.miemiedev</groupId>  
  9.       <artifactId>mybatis-paginator</artifactId>  
  10.       <version>1.2.17</version>  
  11.     </dependency>  
  12.   
  13.     <dependency>  
  14.       <groupId>com.github.jsqlparser</groupId>  
  15.       <artifactId>jsqlparser</artifactId>  
  16.       <version>0.9.4</version>  
  17.     </dependency>  

2、在spring的配置文件里添加配置

[html] view plain copy
  1. <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">  
  2.     <property name="dataSource" ref="dataSource"/>  
  3.     <property name="mapperLocations" value="classpath*:mappers/*Mapper.xml"/>  
  4.   
  5.     <!-- 分页插件 -->  
  6.     <property name="plugins">  
  7.         <array>  
  8.             <bean class="com.github.pagehelper.PageHelper">  
  9.                 <property name="properties">  
  10.                     <value>  
  11.                         dialect=mysql  
  12.                     </value>  
  13.                 </property>  
  14.             </bean>  
  15.         </array>  
  16.     </property>  
  17.   
  18. </bean>  

注意不同数据库的方言的使用

相关推荐