Mybatis入门(1)

最新推荐文章于 2024-09-01 15:06:47 发布

Lonely You丶

最新推荐文章于 2024-09-01 15:06:47 发布

阅读量188

点赞数 2

本文链接：https://blog.csdn.net/qq_43163499/article/details/85040396

版权

核心
导入依赖
加入插件（插件依赖、插件文件、Free mybatis plugin、Mybatis generater）
生成代码
代码测试

0、系统环境
JDK版本：1.8
IDE：InterliJ IDEA 2017.2.5
Maven版本：3.5
MyBatis版本：3.X
数据库：MySQL 5.5

mybatis
1.1 mybatis本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation迁移到了google code，并且改名为MyBatis。2013年11月迁移到Github。
mybatis是一个基于Java的持久层框架(半自动)，主要包括SQL Maps和Data Access Objects（DAO）
1.2 MyBatis是支持普通SQL查询，存储过程和高级映射的优秀持久层框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。
MyBatis使用简单的 XML或注解用于配置和原始映射，将接口和 Java 的POJOs（Plain Old Java Objects，普通的 Java对象）映射成数据库中的记录。
1.3 每个MyBatis应用程序主要都是使用SqlSessionFactory实例的，一个SqlSessionFactory实例可以通过SqlSessionFactoryBuilder获得。
SqlSessionFactoryBuilder可以从一个xml配置文件或者一个预定义的配置类的实例获得。
```
 2. mybatis与hibernate的区别
两者均为ORM框架，但也有一些不同
mybatis                              hibernate
轻量级                               重量级
半自动化                             全自动化
sql                                  hql(但也可以使用sql，但违背了hibernate的初衷)
扩展性、迁移性比较差                 无缝移植**	   
```
如何在项目中添加mybatis支持
3.1 使用maven创建项目，并添加web支持

3.2 添加相关依赖
junit 4.12
javax.servlet-api 4.0.0
mybatis 3.4.5
mysql-connector-java 5.1.44

3.4 mybatis核心文件配置
mybatis.cfg.xml(使用free mybatis plugins插件创建)
jdbc.properties

3.5 mybatis日志配置(log4j2)
log for java
Mybatis内置的日志工厂提供日志功能，具体的日志实现有以下几种工具：
SLF4J
Apache Commons Logging
Log4j 2
Log4j
JDK logging

  本案例使用log4j2
  1. 添加log4j2相关依赖
     log4j2.pom.txt

  2. 将log4j2.xml复制到resources目录下

  3. 修改mybatis.cfg.xml文件的日志配置
     <setting name="logImpl" value="LOG4J2"/>

  4. web项目还需要修改web.xml文件添加日志开关
     <!-- 禁止自动初始化log4j2 -->
 <context-param>
	<param-name>isLog4jAutoInitializationDisabled</param-name>
	<param-value>false</param-value>
 </context-param>

3.6 运行工具类MybatisSessionFactoryUtils进行测试

ssm与ssh开发对比
ssh2 ssm
action controller
biz/service biz/service
dao mapper
IXxxDAO.java(接口) XxxMapper.java(接口)
XxxDAOImpl.java(实现类) XxxMapper.xml
entity model
Xxx.java Xxx.java
Xxx.hbm.xml

                           注1：自动生成持久层代码
                           注2：接口中的方法必须与XxxMapper.xml中标签中的id属性匹配
                           注3：XxxMapper.java(接口)中的方法只允许一个参数
                           注4：利用OGNL表达式来传递参数
                           注5：resultMap==>result mapping
                           注6：resultMap id
                                result property
                                resultMap="row"
                           注7：Selective，已存在，动态sql

使用MyBatis-generator自动生成MyBatis代码
Xxx.java
XxxMapper.java
XxxMapper.xml

5.1 MAVEN中使用mybatis-generator-maven-plugin插件
因为IntelliJ中没有mybatis-generato对应的插件，所以需要在MAVEN中使用 mybatis-generator-maven-plugin插件来完成功能

  添加mybatis-generator-maven-plugin插件相关依赖：mybatis-generator-maven-plugin.pom.txt

5.2 配置generatorConfig.xml
resources下建generatorConfig.xml,作为mybatis-generator-maven-plugin插件的执行目标

5.3 在Intellij IDEA添加一个“Run运行”选项，使用maven运行mybatis-generator-maven-plugin插件
命令：mybatis-generator:generate -e

注1：XxxMapper.xml中的ID要与XxxMapper.java接口中的方法一致
注2：XxxMapper.java接口的方法，均只能定义一个参数
注3：使用Mybatis-generator时出现以下错误：“ Column name pattern can not be NULL or empty”
错误产生的原因是因为使用了高版本的mysql驱动，请使用较低版本的mysql驱动
注4：IDEA配置使用Mybatis出现 “Could not find resource”
问题：在编译后的target文件夹下，发现只有mapper的class文件，而没有xml文件，
将对应的xml文件放到这个文件夹下运行就不会出现下面的错误。说明出现这个错误的原因是maven编译时没有将xml文件放进去。
解决方法：在pom.xml中添加如下代码

src/main/java

**/.xml

注5：resource jdbc.properties does not exist
问题：在编译后的target文件夹下，而没有jdbc.properties文件，但同时不能少了.xml

src/main/resources

jdbc.properties
*.xml

业务层代码编号(Biz/Service)
junit4单元测试
SqlSession.getMapper(BookMapper.class);
sqlSession.commit();//mybatis默认也是手动事务

org.projectlombok lombok 1.18.2 provided

pom.xml:

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

4.0.0

com.zking
mybatis01
1.0-SNAPSHOT
war

mybatis01 Maven Webapp

http://www.example.com

junit junit 4.12 test

<!-- ********************** Java Servlet API  ********************** -->
<dependency>
  <groupId>javax.servlet</groupId>
  <artifactId>javax.servlet-api</artifactId>
  <version>4.0.0</version>
  <scope>provided</scope>
</dependency>

<!-- ********************** Mybatis依赖 ********************** -->
<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>3.4.5</version>
</dependency>

<!-- ********************** Mysql JDBC驱动 ********************** -->
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.44</version>
</dependency>

<!-- **********************  日志配置  ********************** -->
<!--记得修改mybatis.cfg.xml添加如下内容-->
<!--<setting name="logImpl" value="LOG4J2"/>-->
<!--核心log4j2jar包-->
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-core</artifactId>
  <version>2.9.1</version>
</dependency>
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-api</artifactId>
  <version>2.9.1</version>
</dependency>
<!--web工程需要包含log4j-web，非web工程不需要-->
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-web</artifactId>
  <version>2.9.1</version>
</dependency>

<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.18.2</version>
  <scope>provided</scope>
</dependency>
  </dependencies>
  <build>
    <finalName>mybatis01</finalName>
    <resources>
      <resource>
        <directory>src/main/java</directory>
        <includes>
          <include>**/*.xml</include>
    </includes>
  </resource>
  <resource>
    <directory>src/main/resources</directory>
    <includes>
      <include>jdbc.properties</include>
      <include>*.xml</include>
    </includes>
  </resource>

</resources>

<pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>3.7.0</version>
      <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <encoding>UTF-8</encoding>
      </configuration>
    </plugin>

    <plugin>
      <groupId>org.mybatis.generator</groupId>
      <artifactId>mybatis-generator-maven-plugin</artifactId>
      <version>1.3.2</version>
      <dependencies>
        <!--使用Mybatis-generator插件不能使用太高版本的mysql驱动 -->
        <dependency>
          <groupId>mysql</groupId>
          <artifactId>mysql-connector-java</artifactId>
          <version>5.1.44</version>
        </dependency>
      </dependencies>
      <configuration>
        <overwrite>true</overwrite>
      </configuration>
    </plugin>


    <plugin>
      <artifactId>maven-clean-plugin</artifactId>
      <version>3.1.0</version>
    </plugin>
    <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#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>

安装插件（我的是已经下载好了的。所以没有显示Install。插件名: Free mybatis plugin、Mybatis generater）
在这里插入图片描述
创建文件夹:(因为Idea新建的Maven项目工程目录是不全的，给Maven项目工程结构配全 )

引入外部配置文件到resources
1、导入generatorConfig.xml文件

?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
<generatorConfiguration>
    <!-- 引入配置文件 -->
    <properties resource="jdbc.properties"/>

<!--指定数据库jdbc驱动jar包的位置-->
<classPathEntry location="D:\workspace\maven-repository\mysql\mysql-connector-java\5.1.44\mysql-connector-java-5.1.44.jar"/>

<!-- 一个数据库一个context -->
<context id="infoGuardian">
    <!-- 注释 -->
    <commentGenerator>
        <property name="suppressAllComments" value="true"/><!-- 是否取消注释 -->
        <property name="suppressDate" value="true"/> <!-- 是否生成注释代时间戳 -->
    </commentGenerator>

    <!-- jdbc连接 -->
    <jdbcConnection driverClass="${jdbc.driver}"
                    connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}"/>

    <!-- 类型转换 -->
    <javaTypeResolver>
        <!-- 是否使用bigDecimal， false可自动转化以下类型（Long, Integer, Short, etc.） -->
        <property name="forceBigDecimals" value="false"/>
    </javaTypeResolver>

    <!-- 01 指定javaBean生成的位置 -->
    <!-- targetPackage：指定生成的model生成所在的包名 -->
    <!-- targetProject：指定在该项目下所在的路径  -->
    <javaModelGenerator targetPackage="com.zking.mybatis01.model"
                        targetProject="src/main/java">
        <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
        <property name="enableSubPackages" value="false"/>
        <!-- 是否对model添加构造函数 -->
        <property name="constructorBased" value="true"/>
        <!-- 是否针对string类型的字段在set的时候进行trim调用 -->
        <property name="trimStrings" value="false"/>
        <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
        <property name="immutable" value="false"/>
    </javaModelGenerator>

    <!-- 02 指定sql映射文件生成的位置 -->
    <sqlMapGenerator targetPackage="com.zking.mybatis01.mapper"
                     targetProject="src/main/java">
        <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
        <property name="enableSubPackages" value="false"/>
    </sqlMapGenerator>

    <!-- 03 生成XxxMapper接口 -->
    <!-- type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象 -->
    <!-- type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象 -->
    <!-- type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口 -->
    <javaClientGenerator targetPackage="com.zking.mybatis01.mapper"
                         targetProject="src/main/java" type="XMLMAPPER">
        <!-- 是否在当前路径下新加一层schema,false路径com.oop.eksp.user.model， true:com.oop.eksp.user.model.[schemaName] -->
        <property name="enableSubPackages" value="false"/>
    </javaClientGenerator>

    <!-- 配置表信息 -->
    <!-- schema即为数据库名 -->
    <!-- tableName为对应的数据库表 -->
    <!-- domainObjectName是要生成的实体类 -->
    <!-- enable*ByExample是否生成 example类 -->
    <!--<table schema="" tableName="t_book" domainObjectName="Book"-->
           <!--enableCountByExample="false" enableDeleteByExample="false"-->
           <!--enableSelectByExample="false" enableUpdateByExample="false">-->
        <!--&lt;!&ndash; 忽略列，不生成bean 字段 &ndash;&gt;-->
        <!--&lt;!&ndash; <ignoreColumn column="FRED" /> &ndash;&gt;-->
        <!--&lt;!&ndash; 指定列的java数据类型 &ndash;&gt;-->
        <!--&lt;!&ndash; <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" /> &ndash;&gt;-->
    <!--</table>-->

    <table schema="" tableName="t_mvc_book" domainObjectName="Book"
           enableCountByExample="false" enableDeleteByExample="false"
           enableSelectByExample="false" enableUpdateByExample="false">
        <!-- 忽略列，不生成bean 字段 -->
        <!-- <ignoreColumn column="FRED" /> -->
        <!-- 指定列的java数据类型 -->
        <!-- <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" /> -->
    </table>

</context>

2、导入jdbc.properties文件

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/bookshop?useUnicode=true&characterEncoding=UTF-8
jdbc.username=root
jdbc.password=123

3、导入log4j2.xml文件

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

<!-- status : 指定log4j本身的打印日志的级别.ALL< Trace < DEBUG < INFO < WARN < ERROR 
	< FATAL < OFF。 monitorInterval : 用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s. -->
<Configuration status="WARN" monitorInterval="30">
	<Properties>
		<!-- 配置日志文件输出目录 ${sys:user.home} -->
		<Property name="LOG_HOME">/root/workspace/lucenedemo/logs</Property>
		<property name="ERROR_LOG_FILE_NAME">/root/workspace/lucenedemo/logs/error</property>
		<property name="WARN_LOG_FILE_NAME">/root/workspace/lucenedemo/logs/warn</property>
		<property name="PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} [%t-%L] %-5level %logger{36} - %msg%n</property>
	</Properties>

	<Appenders>
		<!--这个输出控制台的配置 -->
		<Console name="Console" target="SYSTEM_OUT">
			<!-- 控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch) -->
			<ThresholdFilter level="trace" onMatch="ACCEPT"
				onMismatch="DENY" />
			<!-- 输出日志的格式 -->
			<!-- %d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生产时间 %p : 日志输出格式 %c : logger的名称 
				%m : 日志内容，即 logger.info("message") %n : 换行符 %C : Java类名 %L : 日志输出所在行数 %M 
				: 日志输出所在方法名 hostName : 本地机器名 hostAddress : 本地ip地址 -->
			<PatternLayout pattern="${PATTERN}" />
		</Console>

		<!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用 -->
		<!--append为TRUE表示消息增加到指定文件中，false表示消息覆盖指定的文件内容，默认值是true -->
		<File name="log" fileName="logs/test.log" append="false">
			<PatternLayout
				pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
		</File>
		<!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size， 则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 -->
		<RollingFile name="RollingFileInfo" fileName="${LOG_HOME}/info.log"
			filePattern="${LOG_HOME}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
			<!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） -->
			<ThresholdFilter level="info" onMatch="ACCEPT"
				onMismatch="DENY" />
			<PatternLayout
				pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
			<Policies>
				<!-- 基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。 modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am. -->
				<!-- 关键点在于 filePattern后的日期格式，以及TimeBasedTriggeringPolicy的interval， 日期格式精确到哪一位，interval也精确到哪一个单位 -->
				<!-- log4j2的按天分日志文件 : info-%d{yyyy-MM-dd}-%i.log -->
				<TimeBasedTriggeringPolicy interval="1"
					modulate="true" />
				<!-- SizeBasedTriggeringPolicy:Policies子节点， 基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小. -->
				<!-- <SizeBasedTriggeringPolicy size="2 kB" /> -->
			</Policies>
		</RollingFile>

		<RollingFile name="RollingFileWarn" fileName="${WARN_LOG_FILE_NAME}/warn.log"
			filePattern="${WARN_LOG_FILE_NAME}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
			<ThresholdFilter level="warn" onMatch="ACCEPT"
				onMismatch="DENY" />
			<PatternLayout
				pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
			<Policies>
				<TimeBasedTriggeringPolicy />
				<SizeBasedTriggeringPolicy size="2 kB" />
			</Policies>
			<!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
			<DefaultRolloverStrategy max="20" />
		</RollingFile>

		<RollingFile name="RollingFileError" fileName="${ERROR_LOG_FILE_NAME}/error.log"
			filePattern="${ERROR_LOG_FILE_NAME}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd-HH-mm}-%i.log">
			<ThresholdFilter level="error" onMatch="ACCEPT"
				onMismatch="DENY" />
			<PatternLayout
				pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
			<Policies>
				<!-- log4j2的按分钟 分日志文件 : warn-%d{yyyy-MM-dd-HH-mm}-%i.log -->
				<TimeBasedTriggeringPolicy interval="1"
					modulate="true" />
				<!-- <SizeBasedTriggeringPolicy size="10 MB" /> -->
			</Policies>
		</RollingFile>

	</Appenders>

	<!--然后定义logger，只有定义了logger并引入的appender，appender才会生效 -->
	<Loggers>
		<!--过滤掉spring和mybatis的一些无用的DEBUG信息 -->
		<logger name="org.springframework" level="INFO"></logger>
		<logger name="org.mybatis" level="INFO"></logger>

		<!-- 第三方日志系统 -->
		<logger name="org.springframework" level="ERROR" />
		<logger name="org.hibernate" level="ERROR" />
		<logger name="org.apache.struts2" level="ERROR" />
		<logger name="com.opensymphony.xwork2" level="ERROR" />
		<logger name="org.jboss" level="ERROR" />


		<!-- 配置日志的根节点 -->
		<root level="all">
			<appender-ref ref="Console" />
			<appender-ref ref="RollingFileInfo" />
			<appender-ref ref="RollingFileWarn" />
			<appender-ref ref="RollingFileError" />
		</root>

	</Loggers>

</Configuration>

4.导入mybatis.cfg.xml文件：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<!-- 引入外部配置文件 -->
<properties resource="jdbc.properties"/>

<settings>
    <setting name="logImpl" value="LOG4J2"/>
</settings>

<!-- 别名 -->
<typeAliases>
    <typeAlias type="com.zking.oa.model.Book" alias="Book"/>
</typeAliases>


<!-- 配置mybatis运行环境 -->
<environments default="development">
    <environment id="development">
        <!-- type="JDBC" 代表使用JDBC的提交和回滚来管理事务 -->
        <transactionManager type="jdbc"/>

        <!-- mybatis提供了3种数据源类型，分别是：POOLED,UNPOOLED,JNDI -->
        <!-- POOLED 表示支持JDBC数据源连接池 -->
        <!-- UNPOOLED 表示不支持数据源连接池 -->
        <!-- JNDI 表示支持外部数据源连接池 -->
        <dataSource type="POOLED">
            <property name="driver"
                      value="${jdbc.driver}"/>
            <property name="url"
                      value="${jdbc.url}"/>
            <property name="username" value="${jdbc.username}"/>
            <property name="password" value="${jdbc.password}"/>
        </dataSource>
    </environment>
</environments>

<mappers>
    <mapper resource="com/zking/oa/mapper/BookMapper.xml"/>
</mappers>

将mybatis的逆向生成代码的命令集成到Maven
在这里插入图片描述
之后在generatorConfig.xml里面执行一次，就可以了，就有了实体类和方法