一、mybatis環境搭建
1.創建maven工程配置環境
打開IDEA ,File->New->Project,右邊選擇Maven,左邊不要勾選任何東西,點擊next,輸入項目名稱即可。
在pom.xml文件中添加如下內容:packaging是打包方式,log4j是爲了輸出日誌,junit是爲了單元測試。其中版本號視各自版本來定。
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.6</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.18</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13-rc-2</version>
<scope>test</scope>
</dependency>
</dependencies>
2.創建實體類和dao接口
事先準備好數據庫,創建一個user表,如下圖:
對應的SQL語句如下:
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` int(11) NOT NULL auto_increment,
`username` varchar(32) NOT NULL COMMENT '用戶名稱',
`birthday` datetime default NULL COMMENT '生日',
`sex` char(1) default NULL COMMENT '性別',
`address` varchar(256) default NULL COMMENT '地址',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
insert into `user`(`id`,`username`,`birthday`,`sex`,`address`) values (41,'老王','2018-02-27 17:47:08','男','北京'),(42,'小二王','2018-03-02 15:09:37','女','北京金燕龍'),(43,'小二王','2018-03-04 11:34:34','女','北京金燕龍'),(45,'傳智播客','2018-03-04 12:04:06','男','北京金燕龍'),(46,'老王','2018-03-07 17:37:26','男','北京'),(48,'小馬寶莉','2018-03-08 11:44:00','女','北京修正');
在src/main/java目錄創建domain包,在domain下創建實體類User,類的屬性和數據庫中表的屬性保持一致,每個屬性都有Get()和Set()方法,最後覆蓋toString()函數。如下:
public class User implements Serializable {
private Integer id;
private String username;
private Date birthday;
private String sex;
private String address;
@Override
public String toString() {
return "User{" +
"id=" + id +
", username='" + username + '\'' +
", birthday=" + birthday +
", sex='" + sex + '\'' +
", address='" + address + '\'' +
'}';
}
}
在src/main/java目錄創建dao包,在dao包下創建接口IUserDao,包含一個查詢所有用戶的findAll()函數,如下:
public interface IUserDao {
//查詢所有用戶
List<User> findAll();
}
3.創建mybatis主配置文件
在resources目錄下創建主配置文件,名稱任意,一般爲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">
<!-- mybatis的主配置文件 -->
<configuration>
<!-- 配置環境 -->
<environments default="mysql">
<!-- 配置mysql的環境 -->
<environment id="mysql">
<!-- 配置事務的類型 -->
<transactionManager type="JDBC"></transactionManager>
<!-- 配置數據源(連接池) -->
<dataSource type="POOLED">
<!-- 配置連接數據庫的四個基本信息 -->
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
<property name="username" value="root"/>
<property name="password" value="12345678"/>
</dataSource>
</environment>
</environments>
<!-- 指定映射配置文件的位置,映射配置文件指的是每個dao獨立的配置文件 -->
<mappers>
<mapper resource="dao/IUserDao.xml" />
</mappers>
</configuration>
在同級目錄下創建log4j.properties文件,配置log4j,便於查看日誌。
# Set root category priority to INFO and its only appender to CONSOLE.
#log4j.rootCategory=INFO, CONSOLE debug info warn error fatal
log4j.rootCategory=debug, CONSOLE, LOGFILE
# Set the enterprise logger category to FATAL and its only appender to CONSOLE.
log4j.logger.org.apache.axis.enterprise=FATAL, CONSOLE
# CONSOLE is set to be a ConsoleAppender using a PatternLayout.
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n
# LOGFILE is set to be a File appender using a PatternLayout.
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
log4j.appender.LOGFILE.File=axis.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n
4.創建映射配置文件
在resources目錄下創建dao目錄,然後在dao目錄下創建映射配置文件,注意SqlMapConfig的<mappers>標籤下的resource屬性要和此處的文件名對應,namespace就是一個命名空間,類似於包。
<?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="dao.IUserDao">
<!-- 配置查詢所有 -->
<select id="findAll" resultType="domain.User">
select * from user;
</select>
</mapper>
5.環境搭建的注意事項
1.在mybatis中,持久層的操作接口名稱和映射配置文件也叫mapper,所以IUserDao.xml有時候也叫做IUserMapper.xml。
2.MyBatis的映射配置文件位置必須和dao接口的包結構相同。
3.映射配置文件的mapper標籤的namespace屬性的取值必須是dao接口的全限定類名。
4.映射配置文件的操作配置(如select),id屬性的取值必須是dao接口的方法名,因爲查詢操作有返回值,所以必須指定一個返回的結果類型,屬性爲resultType,取值是返回值的類,這裏就是user。
5.在實際開發中,通常會嚴格按照2,3,4點進行,因爲當我們按照此規則時,就無需再寫dao的實現類。
二、通過配置文件來實現入門實例
1.測試函數運行
在test/java中創建包創建類MybatisTest,在類中創建Main函數,主要有以下幾步:
1.讀取配置文件
2.創建SqlSessionFactory工廠
3.使用工廠生產SqlSession對象
4.使用SqlSession創建Dao的代理對象
5.使用代理對象執行方法
6.釋放資源
public class MybatisTest {
public static void main(String[] args) throws Exception{
//1.讀取配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//2.創建SqlSessionFactory工廠
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(in);
//3.使用工廠生產SqlSession對象
SqlSession session = factory.openSession();
//4.使用SqlSession創建Dao的代理對象
IUserDao userDao = session.getMapper(IUserDao.class);
//5.使用代理對象執行方法
List<User> users = userDao.findAll();
for(User user : users) {
System.out.println(user);
}
//6.釋放資源
session.close();
in.close();
}
}
最後點擊運行,運行時可能會報錯“java不支持發行版本 5”,這主要是因爲是因爲Maven默認的Java版本是1.5,而大部分人裝的都是新的版本,可參考Intellij idea 報錯:Error : java 不支持發行版本5。最終運行結果如下:
三、通過註解來實現入門實例
1.代碼修改
在使用註解來進行開發時,和使用xml來指定映射略有不同,主要在如下幾點:
1.在上述項目的resources目錄下的dao目錄中刪除文件IUserDao.xml,並且將主配置文件SqlMapConfig.xml的<mappers>標籤修改爲如下:
<!-- 使用註解方式配置,需要使用class屬性指出被註解dao的全限定類名 -->
<mappers>
<mapper class="dao.IUserDao" />
</mappers>
2.在src/main/java目錄下的dao包中的IUserDao類的findAll()方法上添加@Select註解:
public interface IUserDao {
//查詢所有用戶操作
@Select("select * from user")
List<User> findAll();
}
四、通過自定義DAO實現類來實現入門實例
1.代碼修改
自定義DAO實現類時,和第一個項目的不同之處在於如下幾點:
1.在src/main/java目錄的dao包下創建impl包,並在impl包下創建DAO實現類UserDaoImpl,如下:
public class UserDaoImpl implements IUserDao {
private SqlSessionFactory factory;
public UserDaoImpl(SqlSessionFactory factory){
this.factory = factory;
}
public List<User> findAll(){
//1.使用工廠創建SqlSession對象
SqlSession session = factory.openSession();
//2.使用session執行查詢所有方法
List<User> users = session.selectList("dao.IUserDao.findAll");
session.close();
//3.返回查詢結果
return users;
}
}
2.對src/test/java目錄下的test包中的MybatisTest類進行修改如下:
public class MybatisTest {
public static void main(String[] args) throws Exception{
//1.讀取配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//2.創建SqlSessionFactory工廠
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(in);
//3.使用工廠創建dao對象
IUserDao userDao = new UserDaoImpl(factory);
//4.使用dao對象執行方法
List<User> users = userDao.findAll();
for(User user : users) {
System.out.println(user);
}
//5.釋放資源
in.close();
}
}