MyBatis 注解整合教程：快速入门指南

使用注解的方式整合 MyBatis：快速入门指南

本文将带你一步步学习如何使用注解的方式整合 MyBatis，并提供简洁明了的代码示例。

步骤：

添加 MyBatis 依赖： 在你的应用程序构建文件中（例如 Maven 的 pom.xml）添加 MyBatis 依赖项。

<dependencies>
    <!-- MyBatis Core -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    
    <!-- MyBatis Annotation -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis-annotations</artifactId>
        <version>1.0.0</version>
    </dependency>
    
    <!-- 数据库驱动，例如 MySQL -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.23</version>
    </dependency>
</dependencies>

配置数据源： 在应用程序配置文件中（例如 application.properties 或 application.yml）添加数据库连接信息。

spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase
spring.datasource.username=root
spring.datasource.password=secret
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

创建数据访问接口： 创建一个接口，用于定义数据库操作方法。使用注解来指定 SQL 语句和参数映射。

@Mapper
public interface UserMapper {
    
    @Select('SELECT * FROM users WHERE id = #{id}')
    User getUserById(Long id);
    
    @Insert('INSERT INTO users (name, email) VALUES (#{name}, #{email})')
    @Options(useGeneratedKeys = true, keyProperty = 'id')
    void insertUser(User user);
    
    // 其他数据库操作方法...
}

创建数据访问接口实现： 创建一个接口实现类，用于实现数据访问接口中定义的方法。

@Service
public class UserMapperImpl implements UserMapper {
    
    private final SqlSessionFactory sqlSessionFactory;

    @Autowired
    public UserMapperImpl(SqlSessionFactory sqlSessionFactory) {
        this.sqlSessionFactory = sqlSessionFactory;
    }

    @Override
    public User getUserById(Long id) {
        try (SqlSession session = sqlSessionFactory.openSession()) {
            return session.getMapper(UserMapper.class).getUserById(id);
        }
    }

    @Override
    public void insertUser(User user) {
        try (SqlSession session = sqlSessionFactory.openSession()) {
            session.getMapper(UserMapper.class).insertUser(user);
        }
    }
    
    // 其他数据库操作方法的实现...
}

配置 MyBatis： 在应用程序配置文件中，配置 MyBatis 的相关信息。

@Configuration
@MapperScan(basePackages = 'com.example.mapper') // 指定 Mapper 接口的扫描路径
public class MyBatisConfig {

    @Autowired
    private DataSource dataSource;

    @Bean
    public SqlSessionFactoryBean sqlSessionFactory() throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource);
        Resource[] resources = new PathMatchingResourcePatternResolver()
                .getResources('classpath:mapper/*.xml'); // 如果有 XML 映射文件，则需要指定映射文件的路径
        sessionFactory.setMapperLocations(resources);
        return sessionFactory;
    }
    
}

使用注解的方式进行数据库操作： 在应用程序的其他组件中，可以直接注入并使用数据访问接口进行数据库操作。

@RestController
public class UserController {

    private final UserMapper userMapper;

    @Autowired
    public UserController(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    @GetMapping('/users/{id}')
    public User getUser(@PathVariable Long id) {
        return userMapper.getUserById(id);
    }

    @PostMapping('/users')
    public void createUser(@RequestBody User user) {
        userMapper.insertUser(user);
    }

    // 其他接口和操作...
}

注意：

在使用注解方式时，需要将 Mapper 接口和对应的实现类添加相应的注解（如 @Mapper 和 @Service），并配置正确的扫描路径。
确保正确配置数据库连接信息和 SqlSessionFactory。

通过以上步骤，你可以轻松地使用注解的方式整合 MyBatis，实现对数据库的各种操作。祝你编码愉快！