1.1MyBatis簡介
MyBatis 是一個能夠自定義SQL、存儲過程和高級映射的持久層框架。MyBatis 摒除了大部分的JDBC代碼、手工設置參數和結果集重獲。MyBatis 只使用簡單的XML 和註解來配置和映射基本數據類型、Map 接口和POJO 到數據庫記錄。相對Hibernate和Apache OJB等「一站式」ORM解決方案而言,Mybatis 是一種「半自動化」的ORM實現。
須要使用的Jar包:mybatis-3.0.2.jar(mybatis核心包)。mybatis-spring-1.0.0.jar(與Spring結合包)。java
下載地址:
http://ibatis.apache.org/tools/ibator
http://code.google.com/p/mybatis/mysql
1.2MyBatis+Spring+MySql簡單配置
1.2.1搭建Spring環境
1,創建maven的web項目;
2,加入Spring框架、配置文件;
3,在pom.xml中加入所須要的jar包(spring框架的、mybatis、mybatis-spring、junit等);
4,更改web.xml和spring的配置文件;
5,添加一個jsp頁面和對應的Controller;
6,測試。web
可參照:http://limingnihao.iteye.com/blog/830409。使用Eclipse的Maven構建SpringMVC項目spring
1.2.2創建MySql數據庫
創建一個測試數據庫。sql
使用下面的sql進行建數據庫,先創建學生表,插入數據(2條以上)。數據庫
更多sql請下載項目源文件,在resource/sql中。apache
- /* 創建數據庫 */
- CREATE DATABASE STUDENT_MANAGER;
- USE STUDENT_MANAGER;
-
- /***** 創建student表 *****/
- CREATE TABLE STUDENT_TBL
- (
- STUDENT_ID VARCHAR(255) PRIMARY KEY,
- STUDENT_NAME VARCHAR(10) NOT NULL,
- STUDENT_SEX VARCHAR(10),
- STUDENT_BIRTHDAY DATE,
- CLASS_ID VARCHAR(255)
- );
-
- /*插入學生數據*/
- INSERT INTO STUDENT_TBL (STUDENT_ID,
- STUDENT_NAME,
- STUDENT_SEX,
- STUDENT_BIRTHDAY,
- CLASS_ID)
- VALUES (123456,
- '某某某',
- '女',
- '1980-08-01',
- 121546
- )
建立鏈接MySql使用的配置文件mysql.properties。緩存
- jdbc.driverClassName=com.mysql.jdbc.Driver
- jdbc.url=jdbc:mysql://localhost:3306/student_manager?user=root&password=limingnihao&useUnicode=true&characterEncoding=UTF-8
1.2.3搭建MyBatis環境
順序隨便,如今的順序是由於能夠儘可能的少的修改寫好的文件。tomcat
1.2.3.1建立實體類: StudentEntity
- public class StudentEntity implements Serializable {
-
- private static final long serialVersionUID = 3096154202413606831L;
- private ClassEntity classEntity;
- private Date studentBirthday;
- private String studentID;
- private String studentName;
- private String studentSex;
-
- public ClassEntity getClassEntity() {
- return classEntity;
- }
-
- public Date getStudentBirthday() {
- return studentBirthday;
- }
-
- public String getStudentID() {
- return studentID;
- }
-
- public String getStudentName() {
- return studentName;
- }
-
- public String getStudentSex() {
- return studentSex;
- }
-
- public void setClassEntity(ClassEntity classEntity) {
- this.classEntity = classEntity;
- }
-
- public void setStudentBirthday(Date studentBirthday) {
- this.studentBirthday = studentBirthday;
- }
-
- public void setStudentID(String studentID) {
- this.studentID = studentID;
- }
-
- public void setStudentName(String studentName) {
- this.studentName = studentName;
- }
-
- public void setStudentSex(String studentSex) {
- this.studentSex = studentSex;
- }
- }
1.2.3.2建立數據訪問接口
Student類對應的dao接口:StudentMapper。mybatis
- public interface StudentMapper {
-
- public StudentEntity getStudent(String studentID);
-
- public StudentEntity getStudentAndClass(String studentID);
-
- public List<StudentEntity> getStudentAll();
-
- public void insertStudent(StudentEntity entity);
-
- public void deleteStudent(StudentEntity entity);
-
- public void updateStudent(StudentEntity entity);
- }
1.2.3.3建立SQL映射語句文件
Student類的sql語句文件StudentMapper.xml
resultMap標籤:表字段與屬性的映射。
Select標籤:查詢sql。
- <?xml version="1.0" encoding="UTF-8" ?>
- <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
- <mapper namespace="com.manager.data.StudentMapper">
-
- <resultMap type="StudentEntity" id="studentResultMap">
- <id property="studentID" column="STUDENT_ID"/>
- <result property="studentName" column="STUDENT_NAME"/>
- <result property="studentSex" column="STUDENT_SEX"/>
- <result property="studentBirthday" column="STUDENT_BIRTHDAY"/>
- </resultMap>
-
-
- <select id="getStudent" parameterType="String" resultType="StudentEntity" resultMap="studentResultMap">
- <![CDATA[
- SELECT * from STUDENT_TBL ST
- WHERE ST.STUDENT_ID = #{studentID}
- ]]>
- </select>
-
-
- <select id="getStudentAll" resultType="com.manager.data.model.StudentEntity" resultMap="studentResultMap">
- <![CDATA[
- SELECT * from STUDENT_TBL
- ]]>
- </select>
-
- </mapper>
1.2.3.4建立MyBatis的mapper配置文件
在src/main/resource中建立MyBatis配置文件:mybatis-config.xml。
typeAliases標籤:給類起一個別名。com.manager.data.model.StudentEntity類,可使用StudentEntity代替。
Mappers標籤:加載MyBatis中實體類的SQL映射語句文件。
- <?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>
- <typeAliases>
- <typeAlias alias="StudentEntity" type="com.manager.data.model.StudentEntity"/>
- </typeAliases>
- <mappers>
- <mapper resource="com/manager/data/maps/StudentMapper.xml" />
- </mappers>
- </configuration>
1.2.3.5修改Spring 的配置文件
主要是添加SqlSession的製做工廠類的bean:SqlSessionFactoryBean,(在mybatis.spring包中)。須要指定配置文件位置和dataSource。
和數據訪問接口對應的實現bean。經過MapperFactoryBean建立出來。須要執行接口類全稱和SqlSession工廠bean的引用。
- <context:property-placeholder location="classpath:mysql.properties" />
-
- <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
- <property name="driverClassName" value="${jdbc.driverClassName}" />
- <property name="url" value="${jdbc.url}" />
- </bean>
-
- <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
- <property name="dataSource" ref="dataSource" />
- </bean>
-
- <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
- <property name="configLocation" value="classpath:mybatis-config.xml" />
- <property name="dataSource" ref="dataSource" />
- </bean>
-
- <!— mapper bean -->
- <bean id="studentMapper" class="org.mybatis.spring.MapperFactoryBean">
- <property name="mapperInterface" value="com.manager.data.StudentMapper" />
- <property name="sqlSessionFactory" ref="sqlSessionFactory" />
- </bean>
也能夠不定義mapper的bean,使用註解:
將StudentMapper加入註解
- @Repository
- @Transactional
- public interface StudentMapper {
- }
對應的須要在dispatcher-servlet.xml中加入掃描:
- <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
- <property name="annotationClass" value="org.springframework.stereotype.Repository"/>
- <property name="basePackage" value="com.liming.manager"/>
- <property name="sqlSessionFactory" ref="sqlSessionFactory"/>
- </bean>
1.2.4測試StudentMapper
使用SpringMVC測試,建立一個TestController,配置tomcat,訪問index.do頁面進行測試:
- @Controller
- public class TestController {
-
- @Autowired
- private StudentMapper studentMapper;
-
- @RequestMapping(value = "index.do")
- public void indexPage() {
- StudentEntity entity = studentMapper.getStudent("10000013");
- System.out.println("name:" + entity.getStudentName());
- }
- }
使用Junit測試:
- 使用Junit測試:
- Java代碼
- @RunWith(value = SpringJUnit4ClassRunner.class)
- @ContextConfiguration(value = "test-servlet.xml")
- public class StudentMapperTest {
-
- @Autowired
- private ClassMapper classMapper;
-
- @Autowired
- private StudentMapper studentMapper;
-
- @Transactional
- public void getStudentTest(){
- StudentEntity entity = studentMapper.getStudent("10000013");
- System.out.println("" + entity.getStudentID() + entity.getStudentName());
-
- List<StudentEntity> studentList = studentMapper.getStudentAll();
- for( StudentEntity entityTemp : studentList){
- System.out.println(entityTemp.getStudentName());
- }
-
- }
- }
SQL 映射XML 文件是全部sql語句放置的地方。須要定義一個workspace,通常定義爲對應的接口類的路徑。寫好SQL語句映射文件後,須要在MyBAtis配置文件mappers標籤中引用,例如:
- <mappers>
- <mapper resource="com/liming/manager/data/mappers/UserMapper.xml" />
- <mapper resource="com/liming/manager/data/mappers/StudentMapper.xml" />
- <mapper resource="com/liming/manager/data/mappers/ClassMapper.xml" />
- <mapper resource="com/liming/manager/data/mappers/TeacherMapper.xml" />
- </mappers>
當Java接口與XML文件在一個相對路徑下時,能夠不在myBatis配置文件的mappers中聲明。
SQL 映射XML 文件一些初級的元素:
1. cache – 配置給定模式的緩存
2. cache-ref – 從別的模式中引用一個緩存
3. resultMap – 這是最複雜而卻強大的一個元素了,它描述如何從結果集中加載對象
4. sql – 一個能夠被其餘語句複用的SQL 塊
5. insert – 映射INSERT 語句
6. update – 映射UPDATE 語句
7. delete – 映射DELEETE 語句
8. select - 映射SELECT語句
2.1 resultMap
resultMap 是MyBatis 中最重要最強大的元素了。你可讓你比使用JDBC 調用結果集省掉90%的代碼,也可讓你作許多JDBC 不支持的事。現實上,要寫一個等同相似於交互的映射這樣的複雜語句,可能要上千行的代碼。ResultMaps 的目的,就是這樣簡單的語句而不須要多餘的結果映射,更多複雜的語句,除了只要一些絕對必須的語句描述關係之外,不再須要其它的。
resultMap屬性:type爲java實體類;id爲此resultMap的標識。
resultMap能夠設置的映射:
1. constructor – 用來將結果反射給一個實例化好的類的構造器
a) idArg – ID 參數;將結果集標記爲ID,以方便全局調用
b) arg –反射到構造器的一般結果
2. id – ID 結果,將結果集標記爲ID,以方便全局調用
3. result – 反射到JavaBean 屬性的普通結果
4. association – 複雜類型的結合;多個結果合成的類型
a) nested result mappings – 幾resultMap 自身嵌套關聯,也能夠引用到一個其它上
5. collection –複雜類型集合a collection of complex types
6. nested result mappings – resultMap 的集合,也能夠引用到一個其它上
7. discriminator – 使用一個結果值以決定使用哪一個resultMap
a) case – 基本一些值的結果映射的case 情形
i. nested result mappings –一個case 情形自己就是一個結果映射,所以也能夠包括一些相同的元素,也能夠引用一個外部resultMap。
2.1.1 id、result
id、result是最簡單的映射,id爲主鍵映射;result其餘基本數據庫表字段到實體類屬性的映射。
最簡單的例子:
- <resultMap type="liming.student.manager.data.model.StudentEntity" id="studentResultMap">
- <id property="studentId" column="STUDENT_ID" javaType="String" jdbcType="VARCHAR"/>
- <result property="studentName" column="STUDENT_NAME" javaType="String" jdbcType="VARCHAR"/>
- <result property="studentSex" column="STUDENT_SEX" javaType="int" jdbcType="INTEGER"/>
- <result property="studentBirthday" column="STUDENT_BIRTHDAY" javaType="Date" jdbcType="DATE"/>
- <result property="studentPhoto" column="STUDENT_PHOTO" javaType="byte[]" jdbcType="BLOB" typeHandler="org.apache.ibatis.type.BlobTypeHandler" />
- </resultMap>
id、result語句屬性配置細節:
屬性 |
描述 |
|
property |
須要映射到JavaBean 的屬性名稱。 |
|
column |
數據表的列名或者標籤別名。 |
|
javaType |
一個完整的類名,或者是一個類型別名。若是你匹配的是一個JavaBean,那MyBatis 一般會自行檢測到。而後,若是你是要映射到一個HashMap,那你須要指定javaType 要達到的目的。 |
|
jdbcType |
數據表支持的類型列表。這個屬性只在insert,update 或delete 的時候針對容許空的列有用。JDBC 須要這項,但MyBatis 不須要。若是你是直接針對JDBC 編碼,且有容許空的列,而你要指定這項。 |
|
typeHandler |
使用這個屬性能夠覆寫類型處理器。這項值能夠是一個完整的類名,也能夠是一個類型別名。 |
|
支持的JDBC類型
爲了未來的引用,MyBatis 支持下列JDBC 類型,經過JdbcType 枚舉:
BIT,FLOAT,CHAR,TIMESTAMP,OTHER,UNDEFINED,TINYINT,REAL,VARCHAR,BINARY,BLOB,NVARCHAR,SMALLINT,DOUBLE,LONGVARCHAR,VARBINARY,CLOB,NCHAR,INTEGER,NUMERIC,DATE,LONGVARBINARY,BOOLEAN,NCLOB,BIGINT,DECIMAL,TIME,NULL,CURSOR
2.1.2 constructor
咱們使用id、result時候,須要定義java實體類的屬性映射到數據庫表的字段上。這個時候是使用JavaBean實現的。固然咱們也可使用實體類的構造方法來實現值的映射,這個時候是經過構造方法參數的書寫的順序來進行賦值的。
使用construcotr功能有限(例如使用collection級聯查詢)。
上面使用id、result實現的功能就能夠改成:
- <resultMap type="StudentEntity" id="studentResultMap" >
- <constructor>
- <idArg javaType="String" column="STUDENT_ID"/>
- <arg javaType="String" column="STUDENT_NAME"/>
- <arg javaType="String" column="STUDENT_SEX"/>
- <arg javaType="Date" column="STUDENT_BIRTHDAY"/>
- </constructor>
- </resultMap>
固然,咱們須要定義StudentEntity實體類的構造方法:
- public StudentEntity(String studentID, String studentName, String studentSex, Date studentBirthday){
- this.studentID = studentID;
- this.studentName = studentName;
- this.studentSex = studentSex;
- this.studentBirthday = studentBirthday;
- }
2.1.3 association聯合
聯合元素用來處理「一對一」的關係。須要指定映射的Java實體類的屬性,屬性的javaType(一般MyBatis 本身會識別)。對應的數據庫表的列名稱。若是想覆寫的話返回結果的值,須要指定typeHandler。
不一樣狀況須要告訴MyBatis 如何加載一個聯合。MyBatis 能夠用兩種方式加載:
1. select: 執行一個其它映射的SQL 語句返回一個Java實體類型。較靈活;
2. resultsMap: 使用一個嵌套的結果映射來處理經過join查詢結果集,映射成Java實體類型。
例如,一個班級對應一個班主任。
首先定義好班級中的班主任屬性:
- private TeacherEntity teacherEntity;
2.1.3.1使用select實現聯合
例:班級實體類中有班主任的屬性,經過聯合在獲得一個班級實體時,同時映射出班主任實體。
這樣能夠直接複用在TeacherMapper.xml文件中定義好的查詢teacher根據其ID的select語句。並且不須要修改寫好的SQL語句,只須要直接修改resultMap便可。
ClassMapper.xml文件部份內容:
- <resultMap type="ClassEntity" id="classResultMap">
- <id property="classID" column="CLASS_ID" />
- <result property="className" column="CLASS_NAME" />
- <result property="classYear" column="CLASS_YEAR" />
- <association property="teacherEntity" column="TEACHER_ID" select="getTeacher"/>
- </resultMap>
-
- <select id="getClassByID" parameterType="String" resultMap="classResultMap">
- SELECT * FROM CLASS_TBL CT
- WHERE CT.CLASS_ID = #{classID};
- </select>
TeacherMapper.xml文件部份內容:
- <resultMap type="TeacherEntity" id="teacherResultMap">
- <id property="teacherID" column="TEACHER_ID" />
- <result property="teacherName" column="TEACHER_NAME" />
- <result property="teacherSex" column="TEACHER_SEX" />
- <result property="teacherBirthday" column="TEACHER_BIRTHDAY"/>
- <result property="workDate" column="WORK_DATE"/>
- <result property="professional" column="PROFESSIONAL"/>
- </resultMap>
-
- <select id="getTeacher" parameterType="String" resultMap="teacherResultMap">
- SELECT *
- FROM TEACHER_TBL TT
- WHERE TT.TEACHER_ID = #{teacherID}
- </select>
2.1.3.2使用resultMap實現聯合
與上面一樣的功能,查詢班級,同時查詢器班主任。需在association中添加resultMap(在teacher的xml文件中定義好的),新寫sql(查詢班級表left join教師表),不須要teacher的select。
修改ClassMapper.xml文件部份內容:
- <resultMap type="ClassEntity" id="classResultMap">
- <id property="classID" column="CLASS_ID" />
- <result property="className" column="CLASS_NAME" />
- <result property="classYear" column="CLASS_YEAR" />
- <association property="teacherEntity" column="TEACHER_ID" resultMap="teacherResultMap"/>
- </resultMap>
-
- <select id="getClassAndTeacher" parameterType="String" resultMap="classResultMap">
- SELECT *
- FROM CLASS_TBL CT LEFT JOIN TEACHER_TBL TT ON CT.TEACHER_ID = TT.TEACHER_ID
- WHERE CT.CLASS_ID = #{classID};
- </select>
其中的teacherResultMap請見上面TeacherMapper.xml文件部份內容中。
2.1.4 collection彙集
彙集元素用來處理「一對多」的關係。須要指定映射的Java實體類的屬性,屬性的javaType(通常爲ArrayList);列表中對象的類型ofType(Java實體類);對應的數據庫表的列名稱;
不一樣狀況須要告訴MyBatis 如何加載一個彙集。MyBatis 能夠用兩種方式加載:
1. select: 執行一個其它映射的SQL 語句返回一個Java實體類型。較靈活;
2. resultsMap: 使用一個嵌套的結果映射來處理經過join查詢結果集,映射成Java實體類型。
例如,一個班級有多個學生。
首先定義班級中的學生列表屬性:
- private List<StudentEntity> studentList;
2.1.4.1使用select實現彙集
用法和聯合很相似,區別在於,這是一對多,因此通常映射過來的都是列表。因此這裏須要定義javaType爲ArrayList,還須要定義列表中對象的類型ofType,以及必須設置的select的語句名稱(須要注意的是,這裏的查詢student的select語句條件必須是外鍵classID)。
ClassMapper.xml文件部份內容:
- <resultMap type="ClassEntity" id="classResultMap">
- <id property="classID" column="CLASS_ID" />
- <result property="className" column="CLASS_NAME" />
- <result property="classYear" column="CLASS_YEAR" />
- <association property="teacherEntity" column="TEACHER_ID" select="getTeacher"/>
- <collection property="studentList" column="CLASS_ID" javaType="ArrayList" ofType="StudentEntity" select="getStudentByClassID"/>
- </resultMap>
-
- <select id="getClassByID" parameterType="String" resultMap="classResultMap">
- SELECT * FROM CLASS_TBL CT
- WHERE CT.CLASS_ID = #{classID};
- </select>
StudentMapper.xml文件部份內容:
- <!-- java屬性,數據庫表字段之間的映射定義 -->
- <resultMap type="StudentEntity" id="studentResultMap">
- <id property="studentID" column="STUDENT_ID" />
- <result property="studentName" column="STUDENT_NAME" />
- <result property="studentSex" column="STUDENT_SEX" />
- <result property="studentBirthday" column="STUDENT_BIRTHDAY" />
- </resultMap>
-
- <!-- 查詢學生list,根據班級id -->
- <select id="getStudentByClassID" parameterType="String" resultMap="studentResultMap">
- <include refid="selectStudentAll" />
- WHERE ST.CLASS_ID = #{classID}
- </select>
2.1.4.2使用resultMap實現彙集
使用resultMap,就須要重寫一個sql,left join學生表。
- <resultMap type="ClassEntity" id="classResultMap">
- <id property="classID" column="CLASS_ID" />
- <result property="className" column="CLASS_NAME" />
- <result property="classYear" column="CLASS_YEAR" />
- <association property="teacherEntity" column="TEACHER_ID" resultMap="teacherResultMap"/>
- <collection property="studentList" column="CLASS_ID" javaType="ArrayList" ofType="StudentEntity" resultMap="studentResultMap"/>
- </resultMap>
-
- <select id="getClassAndTeacherStudent" parameterType="String" resultMap="classResultMap">
- SELECT *
- FROM CLASS_TBL CT
- LEFT JOIN STUDENT_TBL ST
- ON CT.CLASS_ID = ST.CLASS_ID
- LEFT JOIN TEACHER_TBL TT
- ON CT.TEACHER_ID = TT.TEACHER_ID
- WHERE CT.CLASS_ID = #{classID};
- </select>
其中的teacherResultMap請見上面TeacherMapper.xml文件部份內容中。studentResultMap請見上面StudentMapper.xml文件部份內容中。
2.1.5discriminator鑑別器
有時一個單獨的數據庫查詢也許返回不少不一樣(可是但願有些關聯)數據類型的結果集。鑑別器元素就是被設計來處理這個狀況的,還有包括類的繼承層次結構。鑑別器很是容易理解,由於它的表現很像Java語言中的switch語句。
定義鑑別器指定了column和javaType屬性。列是MyBatis查找比較值的地方。JavaType是須要被用來保證等價測試的合適類型(儘管字符串在不少情形下都會有用)。
下面這個例子爲,當classId爲20000001時,才映射classId屬性。
- <resultMap type="liming.student.manager.data.model.StudentEntity" id="resultMap_studentEntity_discriminator">
- <id property="studentId" column="STUDENT_ID" javaType="String" jdbcType="VARCHAR"/>
- <result property="studentName" column="STUDENT_NAME" javaType="String" jdbcType="VARCHAR"/>
- <result property="studentSex" column="STUDENT_SEX" javaType="int" jdbcType="INTEGER"/>
- <result property="studentBirthday" column="STUDENT_BIRTHDAY" javaType="Date" jdbcType="DATE"/>
- <result property="studentPhoto" column="STUDENT_PHOTO" javaType="byte[]" jdbcType="BLOB" typeHandler="org.apache.ibatis.type.BlobTypeHandler" />
- <result property="placeId" column="PLACE_ID" javaType="String" jdbcType="VARCHAR"/>
- <discriminator column="CLASS_ID" javaType="String" jdbcType="VARCHAR">
- <case value="20000001" resultType="liming.student.manager.data.model.StudentEntity" >
- <result property="classId" column="CLASS_ID" javaType="String" jdbcType="VARCHAR"/>
- </case>
- </discriminator>
- </resultMap>