在Java项目中,MyBatis 是一个优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的过程。下面,我将一步步带你搭建一个使用 MyBatis 的 Java 项目。
环境准备
在开始之前,请确保以下环境已经准备就绪:
- Java Development Kit (JDK): 建议使用 Java 8 或更高版本。
- IDE: 如 IntelliJ IDEA 或 Eclipse。
- Maven: 用于项目的构建和管理依赖。
创建Maven项目
- 打开你的 IDE,创建一个新的 Maven 项目。
- 在
pom.xml文件中添加以下依赖:
<dependencies>
<!-- MyBatis 依赖 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.6</version>
</dependency>
<!-- MySQL 驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.26</version>
</dependency>
<!-- log4j 日志 -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>2.14.1</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.14.1</version>
</dependency>
</dependencies>
- 在
src/main/resources目录下创建application.properties文件,并添加以下内容:
# 数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
配置MyBatis
- 在
src/main/resources目录下创建mybatis-config.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>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
</configuration>
- 在
src/main/java目录下创建com/your/package目录,并在该目录下创建Mapper接口,例如UserMapper.java:
package com.your.package;
public interface UserMapper {
User getUserById(int id);
}
- 在
src/main/java目录下创建com/your/package/mapper目录,并在该目录下创建UserMapper.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">
<mapper namespace="com.your.package.UserMapper">
<select id="getUserById" resultType="com.your.package.User">
SELECT * FROM users WHERE id = #{id}
</select>
</mapper>
- 在
src/main/java目录下创建com/your/package/service目录,并在该目录下创建UserService.java文件,并添加以下内容:
package com.your.package.service;
import com.your.package.mapper.UserMapper;
import com.your.package.model.User;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
public class UserService {
private static SqlSessionFactory sqlSessionFactory;
static {
try {
sqlSessionFactory = new SqlSessionFactoryBuilder().build();
} catch (Exception e) {
e.printStackTrace();
}
}
public User getUserById(int id) {
SqlSession session = sqlSessionFactory.openSession();
try {
UserMapper mapper = session.getMapper(UserMapper.class);
return mapper.getUserById(id);
} finally {
session.close();
}
}
}
测试
- 在
src/test/java目录下创建com/your/package/service/UserServiceTest.java文件,并添加以下内容:
package com.your.package.service;
import org.junit.Test;
import static org.junit.Assert.*;
public class UserServiceTest {
@Test
public void testGetUserById() {
UserService userService = new UserService();
User user = userService.getUserById(1);
assertNotNull(user);
assertEquals("张三", user.getName());
}
}
- 运行测试用例,查看结果。
恭喜你,你已经成功搭建了一个使用 MyBatis 的 Java 项目!接下来,你可以根据自己的需求添加更多的功能。希望这篇文章能帮助你快速入门 MyBatis。
