MyBatis入門基礎(一)

阿赫瓦里發表於2015-06-27

一:對原生態JDBC問題的總結

  新專案要使用mybatis作為持久層框架,由於本人之前一直使用的Hibernate,對mybatis的用法實在欠缺,最近幾天計劃把mybatis學習一哈,特將學習筆記記錄於此,方便大家參考,也方便自己查閱。

  話不多說,先看看原始的JDBC程式程式碼,看看這樣的程式碼存在什麼問題。

package com.utils;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * @ClassName: JdbcTest
 * @Description: TODO(原始的JDBC運算元據庫)
 * @author warcaft
 * @date 2015-6-27 下午3:31:22
 * 
 */
public class JdbcTest {
    public static void main(String[] args) {

        // 資料庫連線
        Connection connection = null;
        // 預編譯的Statement,使用預編譯的Statement提高資料庫效能
        PreparedStatement preparedStatement = null;
        // 結果 集
        ResultSet resultSet = null;

        try {
            // 載入資料庫驅動
            Class.forName("com.mysql.jdbc.Driver");

            // 通過驅動管理類獲取資料庫連結
            connection = DriverManager
                    .getConnection(
                            "jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8",
                            "root", "root");
            // 定義sql語句 ?表示佔位符
            String sql = "select * from t_user where username = ?";
            // 獲取預處理statement
            preparedStatement = connection.prepareStatement(sql);
            // 設定引數,第一個引數為sql語句中引數的序號(從1開始),第二個引數為設定的引數值
            preparedStatement.setString(1, "王五");
            // 向資料庫發出sql執行查詢,查詢出結果集
            resultSet = preparedStatement.executeQuery();
            // 遍歷查詢結果集
            while (resultSet.next()) {
                System.out.println(resultSet.getString("id") + "  "
                        + resultSet.getString("username"));
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            // 釋放資源
            if (resultSet != null) {
                try {
                    resultSet.close();
                } catch (SQLException e) {
                    // TODO Auto-generated catch block
                    e.printStackTrace();
                }
            }
            if (preparedStatement != null) {
                try {
                    preparedStatement.close();
                } catch (SQLException e) {
                    // TODO Auto-generated catch block
                    e.printStackTrace();
                }
            }
            if (connection != null) {
                try {
                    connection.close();
                } catch (SQLException e) {
                    // TODO Auto-generated catch block
                    e.printStackTrace();
                }
            }

        }

    }
}
View Code

上面程式碼的問題總結:

1、資料庫連線,使用時就建立,不使用立即釋放,對資料庫進行頻繁連線開啟和關閉,造成資料庫資源浪費,影響資料庫效能。

解決方案:使用資料庫連線池管理資料庫連線。

2、將sql語句硬編碼到java程式碼中,如果sql 語句修改,需要重新編譯java程式碼,不利於系統維護。

解決方案:將sql語句配置在xml配置檔案中,即使sql變化,不需要對java程式碼進行重新編譯。

3、向preparedStatement中設定引數,對佔位符號位置和設定引數值,硬編碼在java程式碼中,不利於系統維護。

解決方案:將sql語句及佔位符號和引數全部配置在xml中。

4、從resutSet中遍歷結果集資料時,存在硬編碼,將獲取表的欄位進行硬編碼,,不利於系統維護。

解決方案:將查詢的結果集,自動對映成java物件。

二:MyBatis框架

  1.MyBatis是什麼?(下載地址:https://github.com/mybatis/mybatis-3/releases) 

   MyBatis 本是apache的一個開源專案iBatis, 2010年這個專案由apache software foundation 遷移到了google code,並且改名為MyBatis,實質上Mybatis對ibatis進行一些改進。 

  MyBatis是一個優秀的持久層框架,它對jdbc的運算元據庫的過程進行封裝,使開發者只需要關注 SQL 本身,而不需要花費精力去處理例如註冊驅動、建立connection、建立statement、手動設定引數、結果集檢索等jdbc繁雜的過程程式碼。

  Mybatis通過xml或註解的方式將要執行的各種statement(statement、preparedStatemnt、CallableStatement)配置起來,並通過java物件和statement中的sql進行對映生成最終執行的sql語句,最後由mybatis框架執行sql並將結果對映成java物件並返回。

  2.MyBatis架構圖

  

1、mybatis配置

SqlMapConfig.xml,此檔案作為mybatis的全域性配置檔案,配置了mybatis的執行環境等資訊。

mapper.xml檔案即sql對映檔案,檔案中配置了運算元據庫的sql語句。此檔案需要在SqlMapConfig.xml中載入。

 2、通過mybatis環境等配置資訊構造SqlSessionFactory即會話工廠

 3、由會話工廠建立sqlSession即會話,運算元據庫需要通過sqlSession進行。

 4、mybatis底層自定義了Executor執行器介面運算元據庫,Executor介面有兩個實現,一個是基本執行器、一個是快取執行器。

 5、Mapped Statement也是mybatis一個底層封裝物件,它包裝了mybatis配置資訊及sql對映資訊等。mapper.xml檔案中一個sql對應一個Mapped Statement物件,sql的id即是Mapped statement的id。

 6、Mapped Statement對sql執行輸入引數進行定義,包括HashMap、基本型別、pojo,Executor通過Mapped Statement在執行sql前將輸入的java物件對映至sql中,輸入引數對映就是jdbc程式設計中對preparedStatement設定引數。

 7、Mapped Statement對sql執行輸出結果進行定義,包括HashMap、基本型別、pojo,Executor通過Mapped Statement在執行sql後將輸出結果對映至java物件中,輸出結果對映過程相當於jdbc程式設計中對結果的解析處理過程。

三:mybatis入門程式

1.需求:(1).根據使用者id(主鍵)查詢使用者資訊 (2).根據使用者名稱稱模糊查詢使用者資訊(3).新增使用者 4).刪除使用者(5).更新使用者

2.環境:java環境:JDK1.7,eclipse,Mysql5.1

3.工程目錄結構

 

4.從mybatis的jar包結構可知mybatis用的是log4j記錄日誌,所以log4j.properties檔案內容如下:

# Global logging configuration
#在開發的環境下,日誌級別要設定成DEBUG,生產環境設定成info或error
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

5.SqlMapConfig.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>
    <!-- 和spring整合後 environments配置將廢除-->
    <environments default="development">
        <environment id="development">
        <!-- 使用jdbc事務管理,事務控制由mybatis管理-->
            <transactionManager type="JDBC" />
        <!-- 資料庫連線池,由mybatis管理-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver" />
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8" />
                <property name="username" value="root" />
                <property name="password" value="root" />
            </dataSource>
        </environment>
    </environments>
<!-- 載入對映檔案 -->
    <mappers>
        <mapper resource="sqlmap/User.xml"/>
    </mappers>
</configuration>

6.實體User.java內容

package com.mybatis.entity;

import java.util.Date;

/**
 * @ClassName: User
 * @Description: TODO(使用者實體)
 * @author warcaft
 * @date 2015-6-27 下午1:56:02
 * 
 */
public class User {
    // 屬性名稱和資料庫欄位名稱保持一致
    private Integer id;
    // 姓名
    private String username;
    // 性別
    private String sex;
    // 地址
    private String address;
    // 生日
    private Date birthday;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    @Override
    public String toString() {
        return "User [id=" + id + ", username=" + username + ", sex=" + sex
                + ", address=" + address + ", birthday=" + birthday + "]";
    }

}
View Code

7.對映檔案User.xml的內容

<?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">
<!-- namespace名稱空間,作用就是對sql進行分類化的管理,理解為sql隔離
    注意:使用mapper代理開發時,namespace有特殊作用
 -->
<mapper namespace="test">
<!-- 在對映檔案中配置很多sql語句 -->
<!-- 需求:通過Id查詢使用者表的記錄 -->
<!-- 通過SELECT執行資料庫查詢 
    id:標識對映檔案中的sql,稱為statement的id;
        將sql語句封裝在mapperStatement的物件中,所以Id稱為Statement的id;
    parameterType:指定輸入引數的型別,這裡指定int型
    #{}:表示一個佔位符;
    #{id}:其中Id表示接收輸入的引數,引數名稱就是Id,如果輸入引數是簡單型別,#{}中的引數名可以任意,可以是value或者其它名稱;
    resultType:指定sql輸出結果所對映的java物件型別,select指定resultType表示將單條記錄對映成java物件。
-->
<select id="findUserById" parameterType="int" resultType="com.mybatis.entity.User" >
    select * from t_user where id=#{id}
</select>
<!-- 根據使用者名稱稱模糊查詢使用者資訊,可能返回多條資料
    resultType:指定的就是單條記錄所對映的java型別;
    ${}:表示拼接sql字串,將接收到的引數內容不加任何修飾拼接在sql中.
    使用${}拼接sql,可能會引起sql注入
    ${value}:接收輸入引數的內容,如果傳入的是簡單型別,${}中只能使用value
 -->
<select id="findUserByName" parameterType="java.lang.String" resultType="com.mybatis.entity.User" >
    select * from t_user where username LIKE '%${value}%'
</select>
<!-- 新增使用者 
parameterType:指定輸入的引數型別是pojo(包括使用者資訊);
#{}中指定pojo的屬性名稱,接收到pojo物件的屬性值    ,mybatis通過OGNL(類似struts2的OGNL)獲取物件的屬性值
-->
<insert id="insertUser" parameterType="com.mybatis.entity.User" >
    <!-- 
        將insert插入的資料的主鍵返回到User物件中;
        select last_insert_id():得到剛insert進去記錄的主鍵值,只適用於自增主鍵;
        keyProperty:將查詢到的主鍵值,設定到parameterType指定的物件的那個屬性
        order:select last_insert_id()執行順序,相對於insert語句來說它的執行順序。
        resultType:指定select last_insert_id()的結果型別;
     -->
    <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
        select last_insert_id()
    </selectKey>
    <!-- 
        使用mysql的uuid(),實現非自增主鍵的返回。
        執行過程:通過uuid()得到主鍵,將主鍵設定到user物件的Id的屬性中,其次,在insert執行時,從user物件中取出Id屬性值;
     <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String">
        select uuid()
    </selectKey>
        insert into t_user (id,username,birthday,sex,address) values(#{id},#{username},#{birthday},#{sex},#{address})
     -->
    insert into t_user (username,birthday,sex,address) values(#{username},#{birthday},#{sex},#{address})
</insert>
<!-- 刪除使用者 
    根據ID刪除使用者,需要輸入Id值
-->
    <delete id="deleteUser" parameterType="java.lang.Integer">
        delete from t_user where id=#{id}
    </delete>
<!-- 更新使用者 
    需要傳入使用者的Id和使用者的更新資訊
    parameterType:指定User物件,包括Id和使用者的更新資訊,注意:Id是必須存在的
    #{id}:從輸入的User物件中獲取Id的屬性值
-->
<update id="updateUser" parameterType="com.mybatis.entity.User">
    update t_user set username=#{username},birthday=#{birthday},sex=#{sex},address=#{address} 
    where id=#{id}
</update>

</mapper>

8.測試程式MybatisService.java程式碼

package com.mybatis.service;

import java.io.IOException;
import java.io.InputStream;
import java.util.Date;
import java.util.List;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;

import com.mybatis.entity.User;

/**
 * @ClassName: MybatisService
 * @Description: TODO(mybatis入門程式)
 * @author warcaft
 * @date 2015-6-27 下午4:49:49
 * 
 */
public class MybatisService {
    // 根據Id查詢使用者資訊,得到一條記錄結果
    @Test
    public void findUserByIdTest() {
        // mybatis的配置檔案
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = null;
        SqlSession sqlSession = null;
        try {
            inputStream = Resources.getResourceAsStream(resource);
            // 1.建立會話工場,傳入mybatis的配置檔案資訊
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder()
                    .build(inputStream);

            // 2.通過工廠得到SqlSession
            sqlSession = sqlSessionFactory.openSession();

            // 3.通過sqlSession運算元據庫
            // 第一個引數:對映檔案中的statement的Id,等於namespace + "." + statement的id;
            // 第二個引數:指定和對映檔案中所匹配的parameterType型別的引數;
            // sqlSession.selectOne結果是與對映檔案所匹配的resultType型別的物件;
            // selectOne:查詢一條結果
            User user = sqlSession.selectOne("test.findUserById", 1);
            System.out.println(user.toString());

        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (sqlSession != null) {
                sqlSession.close();
            }
            if (inputStream != null) {
                try {
                    inputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    // 根據姓名模糊查詢使用者資訊,得到一條或多條記錄結果
    @Test
    public void findUserByNameTest() {
        // mybatis的配置檔案
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = null;
        SqlSession sqlSession = null;
        try {
            inputStream = Resources.getResourceAsStream(resource);
            // 1.建立會話工場,傳入mybatis的配置檔案資訊
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder()
                    .build(inputStream);

            // 2.通過工廠得到SqlSession
            sqlSession = sqlSessionFactory.openSession();

            // 3.通過sqlSession運算元據庫
            // 第一個引數:對映檔案中的statement的Id,等於namespace + "." + statement的id;
            // 第二個引數:指定和對映檔案中所匹配的parameterType型別的引數;
            // sqlSession.selectOne結果是與對映檔案所匹配的resultType型別的物件;
            // list中的user和resultType型別一致
            List<User> list = sqlSession.selectList("test.findUserByName", "小");
            System.out.println(list);

        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (sqlSession != null) {
                sqlSession.close();
            }
            if (inputStream != null) {
                try {
                    inputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    // 新增使用者
    @Test
    public void insertUserTest() {
        // mybatis的配置檔案
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = null;
        SqlSession sqlSession = null;
        try {
            inputStream = Resources.getResourceAsStream(resource);
            // 1.建立會話工場,傳入mybatis的配置檔案資訊
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder()
                    .build(inputStream);
            // 2.通過工廠得到SqlSession
            sqlSession = sqlSessionFactory.openSession();
            //插入使用者的物件
            User user = new User();
            user.setUsername("小紅");
            user.setBirthday(new Date());
            user.setSex("1");
            user.setAddress("上海");
            // 3.通過sqlSession運算元據庫
            // 第一個引數:對映檔案中的statement的Id,等於namespace + "." + statement的id;
            // 第二個引數:指定和對映檔案中所匹配的parameterType型別的引數;
            // sqlSession.selectOne結果是與對映檔案所匹配的resultType型別的物件;
            sqlSession.insert("test.insertUser", user);
            //執行提交事務
            sqlSession.commit();
            
            //專案中經常需要 獲取新增的使用者的主鍵
            System.out.println(user.getId());

        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (sqlSession != null) {
                sqlSession.close();
            }
            if (inputStream != null) {
                try {
                    inputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }
    
    // 根據Id刪除使用者
        @Test
        public void deleteUserTest() {
            // mybatis的配置檔案
            String resource = "SqlMapConfig.xml";
            InputStream inputStream = null;
            SqlSession sqlSession = null;
            try {
                inputStream = Resources.getResourceAsStream(resource);
                // 1.建立會話工場,傳入mybatis的配置檔案資訊
                SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder()
                        .build(inputStream);
                // 2.通過工廠得到SqlSession
                sqlSession = sqlSessionFactory.openSession();
                // 3.通過sqlSession運算元據庫
                // 第一個引數:對映檔案中的statement的Id,等於namespace + "." + statement的id;
                // 第二個引數:指定和對映檔案中所匹配的parameterType型別的引數;
                // sqlSession.selectOne結果是與對映檔案所匹配的resultType型別的物件;
                //傳入Id,刪除使用者
                sqlSession.delete("test.deleteUser", 7);
                //執行提交事務
                sqlSession.commit();
            } catch (IOException e) {
                e.printStackTrace();
            } finally {
                if (sqlSession != null) {
                    sqlSession.close();
                }
                if (inputStream != null) {
                    try {
                        inputStream.close();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
            }
        }
        
        // 根據Id更新使用者資訊
        @Test
        public void updateUserTest() {
            // mybatis的配置檔案
            String resource = "SqlMapConfig.xml";
            InputStream inputStream = null;
            SqlSession sqlSession = null;
            try {
                inputStream = Resources.getResourceAsStream(resource);
                // 1.建立會話工場,傳入mybatis的配置檔案資訊
                SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder()
                        .build(inputStream);
                // 2.通過工廠得到SqlSession
                sqlSession = sqlSessionFactory.openSession();
                //更新使用者的資訊
                User user = new User();
                user.setId(2);
                user.setUsername("小黑");
                user.setBirthday(new Date());
                user.setSex("2");
                user.setAddress("上海");
                // 3.通過sqlSession運算元據庫
                // 第一個引數:對映檔案中的statement的Id,等於namespace + "." + statement的id;
                // 第二個引數:指定和對映檔案中所匹配的parameterType型別的引數;
                // sqlSession.selectOne結果是與對映檔案所匹配的resultType型別的物件;
                //更具Id更新使用者
                sqlSession.update("test.updateUser", user);
                //執行提交事務
                sqlSession.commit();
            } catch (IOException e) {
                e.printStackTrace();
            } finally {
                if (sqlSession != null) {
                    sqlSession.close();
                }
                if (inputStream != null) {
                    try {
                        inputStream.close();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
            }
        }
}

9.資料庫所用sql指令碼

CREATE TABLE t_user (
  id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
  username VARCHAR(30) NOT NULL COMMENT '使用者名稱稱',
  birthday DATE DEFAULT NULL COMMENT '生日',
  sex CHAR(2) DEFAULT NULL COMMENT '性別',
  address VARCHAR(256) DEFAULT NULL COMMENT '地址'
);
INSERT INTO t_user (username,birthday,sex,address)
                                VALUES
                   ('小A','2015-06-27','2','北京'),
                   ('小B','2015-06-27','2','北京'),
                   ('小C','2015-06-27','1','北京'),
                   ('小D','2015-06-27','2','北京');

四:mybatis和Hibernate的本質區別與應用場景

hibernate:是一個標準ORM框架(物件關係對映),入門門檻較高的,不需要程式寫sqlsql語句自動生成了,對sql語句進行優化、修改比較困難的。

應用場景:

     適用與需求變化不多的中小型專案,比如:後臺管理系統,erpormoa。。

mybatis:專注是sql本身,需要程式設計師自己編寫sql語句,sql修改、優化比較方便。mybatis是一個不完全 的ORM框架,雖然程式設計師自己寫sqlmybatis 也可以實現對映(輸入對映、輸出對映)。

應用場景:

     適用與需求變化較多的專案,比如:網際網路專案。

五:小結

1.parameterType和resultType

  parameterType:在對映檔案中通過parameterType指定輸入 引數的型別。

  resultType:在對映檔案中通過resultType指定輸出結果的型別

 2.#{}和${}

#{}表示一個佔位符號,#{}接收輸入引數,型別可以是簡單型別,pojo、hashmap;

如果接收簡單型別,#{}中可以寫成value或其它名稱;

#{}接收pojo物件值,通過OGNL讀取物件中的屬性值,通過屬性.屬性.屬性...的方式獲取物件屬性值。

 

${}表示一個拼接符號,會引用sql注入,所以不建議使用${};

${}接收輸入引數,型別可以是簡單型別,pojo、hashmap;

如果接收簡單型別,${}中只能寫成value;

${}接收pojo物件值,通過OGNL讀取物件中的屬性值,通過屬性.屬性.屬性...的方式獲取物件屬性值。

3.selectOne()和selectList()

  selectOne表示查詢出一條記錄進行對映。如果使用selectOne可以實現使用selectList也可以實現(list中只有一個物件)。

  selectList表示查詢出一個列表(多條記錄)進行對映。如果使用selectList查詢多條記錄,不能使用selectOne

  如果使用selectOne報錯: org.apache.ibatis.exceptions.TooManyResultsException: Expected one result (or null) to be returned by selectOne(), but found: 4

 

相關文章