Mybatis系列(四)注解

本文详细介绍了一个基于MyBatis注解实现的Spring Boot项目案例,包括Maven配置、数据库连接配置、实体类定义、DAO层接口及其实现类、控制器层等关键组件的设计与实现细节。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Mybatis系列(四)注解

1.pom.xlm:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>spring-mybatis_zhujie</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>spring-mybatis</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.10.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.21</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>


</project>

2.application.properties:

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

server.port=8081

3.mybatis-config-local.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>
    <!-- 引入外部配置文件 -->
    <properties resource="application.properties"></properties>
    <!-- 配置mybatis运行环境 -->
    <environments default="cybatis">
        <environment id="master">
            <!-- type="JDBC" 代表使用JDBC的提交和回滚来管理事务 -->
            <transactionManager type="JDBC" />
            <!-- mybatis提供了3种数据源类型,分别是:POOLED,UNPOOLED,JNDI -->
            <!-- POOLED 表示支持JDBC数据源连接池 -->
            <!-- UNPOOLED 表示不支持数据源连接池 -->
            <!-- JNDI 表示支持外部数据源连接池 -->
            <dataSource type="POOLED">
                <property name="driver" value="${spring.datasource.driver-class-name}" />
                <property name="url" value="${spring.datasource.url}" />
                <property name="username" value="${spring.datasource.username}" />
                <property name="password" value="${spring.datasource.password}" />
            </dataSource>
        </environment>
        <environment id="slave">
            <!-- type="JDBC" 代表使用JDBC的提交和回滚来管理事务 -->
            <transactionManager type="JDBC" />
            <!-- mybatis提供了3种数据源类型,分别是:POOLED,UNPOOLED,JNDI -->
            <!-- POOLED 表示支持JDBC数据源连接池 -->
            <!-- UNPOOLED 表示不支持数据源连接池 -->
            <!-- JNDI 表示支持外部数据源连接池 -->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver" />
                <property name="url" value="jdbc:mysql://localhost:3306/user" />
                <property name="username" value="root" />
                <property name="password" value="root" />
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper class = "com.example.mybatisZhuJie.dao.UserDao"/>
    </mappers>
</configuration>

4.User:

package com.example.mybatisZhuJie.entity;

public class User {
    private int id;
    private String user_name;
    private String password;
    private int age;

    public int getId() {
        return id;
    }

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

    public String getUser_name() {
        return user_name;
    }

    public void setUser_name(String user_name) {
        this.user_name = user_name;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", user_name='" + user_name + '\'' +
                ", password='" + password + '\'' +
                ", age=" + age +
                '}';
    }
}

5.UserDao:

package com.example.mybatisZhuJie.dao;

import com.example.mybatisZhuJie.entity.User;
import org.apache.ibatis.annotations.Delete;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;

import java.util.ArrayList;

public interface UserDao {
    @Select("select id, user_name ,password, age from user_t")
    public ArrayList<User> selectAll();

    @Insert("insert into user_t(id, user_name ,password, age) values(#{id},#{user_name}, #{password}, #{age})")
    public int insert(User user);

    @Delete("delete from user_t where id =#{id}")
    public int delete(@Param("id") int id);

    //Sql语句进行分页
    @Select("select id, user_name ,password, age from user_t limit #{currPage}, #{pageSize}")
    public ArrayList<User> queryStudentsBySql(@Param("currPage") int currPage, @Param("pageSize") int pageSize);
}

6.UserDaoIml:

package com.example.mybatisZhuJie.dao;

import com.example.mybatisZhuJie.entity.User;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

import java.util.ArrayList;

public class UserDaoIml implements UserDao {

    private SqlSessionFactory sessionFactory;

    public UserDaoIml(SqlSessionFactory sessionFactory){
        this.sessionFactory = sessionFactory;
    }

    public ArrayList<User> selectAll() {
        ArrayList<User> users = new ArrayList<>();
        SqlSession sqlSession = null;
        try{
            sqlSession = sessionFactory.openSession();
            UserDao userDao = sqlSession.getMapper(UserDao.class);
            users = userDao.selectAll();
            return users;
        } catch (Exception e) {
            e.printStackTrace();
            return users;
        }
    }

    public int insert(User user) {
        SqlSession sqlSession = null;
        int count = 0;
        try{
            sqlSession = sessionFactory.openSession();
            UserDao userDao = sqlSession.getMapper(UserDao.class);
            count = userDao.insert(user);
            if( count > 0) {
                sqlSession.commit();
            }
            return count;
        } catch (Exception e) {
            e.printStackTrace();
            return count;
        }
    }

    public int delete(int id) {
        SqlSession sqlSession = null;
        int count = 0;
        try{
            sqlSession = sessionFactory.openSession();
            UserDao userDao = sqlSession.getMapper(UserDao.class);
            count = userDao.delete(id);
            if( count > 0) {
                sqlSession.commit();
            }
            return count;
        } catch (Exception e) {
            e.printStackTrace();
            return count;
        }
    }

    public ArrayList<User> queryStudentsBySql(@Param("currPage") int currPage, @Param("pageSize") int pageSize) {
        ArrayList<User> users = new ArrayList<>();
        SqlSession sqlSession = null;
        try{
            sqlSession = sessionFactory.openSession();
            UserDao userDao = sqlSession.getMapper(UserDao.class);
            users = userDao.queryStudentsBySql(currPage, pageSize);
            return users;
        } catch (Exception e) {
            e.printStackTrace();
            return users;
        }
    }
}

7.springboot启动项:

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import java.util.List;
import java.util.Timer;
import java.util.concurrent.TimeoutException;


@SpringBootApplication
public class SpringBootAll {

    private static String env = "local";
    public static SqlSessionFactory sqlSessionFactory;

        public static void main(String[] args) throws Exception{
        new  SpringBootAll().init();
        SpringApplication.run(SpringBootAll.class, args);
    }

        public void init() throws Exception{
        //初始化数据库-单个数据库
        initMySql();
       }

        /**
     * 单个数据库
     */
    private void initMySql(){
        try{
            String resource = String.format("mybatis-config-%s.xml", SpringBootAll.env);
            Reader reader = Resources.getResourceAsReader(resource);
            SpringBootAll.sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

8.controller:

package com.example.mybatisZhuJie.controller;

import com.example.mybatisZhuJie.AppZhuJie;
import com.example.mybatisZhuJie.dao.UserDao;
import com.example.mybatisZhuJie.dao.UserDaoIml;
import com.example.mybatisZhuJie.entity.User;
import org.springframework.web.bind.annotation.*;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@RestController
public class UserController {

    UserDao userDao = new UserDaoIml(SpringBootAll.sqlSessionFactory);

    @RequestMapping(value = "/map", method = RequestMethod.GET)
    @ResponseBody
    public Map<String, Object> getRegTimeByUserId (HttpServletRequest request, HttpServletResponse response) throws Exception{
        Map<String, Object> result = new HashMap<String, Object>();
        String data = request.getParameter("data");
        result.put("data",data);
        result.put("code","200");
        return result;
    }


    @RequestMapping(value = "/select/all", method = RequestMethod.GET)
    @ResponseBody
    public List<User> selectAll(HttpServletRequest request, HttpServletResponse response) throws Exception{
        List<User> users = userDao.selectAll();
        return users;
    }

    @RequestMapping(value = "/select/some", method = RequestMethod.GET)
    @ResponseBody
    public ArrayList<User> selectSome(HttpServletRequest request, HttpServletResponse response
                    ,@RequestParam(value = "start", defaultValue = "0") int start
                    ,@RequestParam(value = "end", defaultValue = "3") int end) throws Exception{
        ArrayList<User> users = userDao.queryStudentsBySql(start, end);
        return users;
    }

    @RequestMapping(value = "/delete", method = RequestMethod.GET)
    @ResponseBody
    public  String delete(@RequestParam(value = "id", defaultValue = "6") int id) {
        int count = userDao.delete(id);
        return "成功删除" + count + "条数据!";
    }

    @RequestMapping(value = "/insert", method = RequestMethod.GET)
    @ResponseBody
    public  String insert(@RequestParam(value = "id", defaultValue = "6") int id
            , @RequestParam(value = "username", defaultValue = "易水寒")String username
            , @RequestParam(value = "password", defaultValue = "yiqq")String password
            , @RequestParam(value = "age", defaultValue = "22") int age) {
        User user = new User();
        user.setId(id);
        user.setAge(age);
        user.setPassword(password);
        user.setUser_name(username);
        int count = userDao.insert(user);
        return "成功插入" + count + "条数据!";
    }


    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    @ResponseBody
    public  String say(@RequestParam(value = "name", defaultValue = "易水寒") String name) {
        return "Hello World: " + name;
    }

}

9.sql:

CREATE TABLE `user_t` (
  `id` int(10) NOT NULL AUTO_INCREMENT,
  `user_name` varchar(10) DEFAULT NULL,
  `password` varchar(10) DEFAULT NULL,
  `age` int(10) DEFAULT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `id` (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=896 DEFAULT CHARSET=utf8

 

转载于:https://www.cnblogs.com/heqiyoujing/p/9470457.html

### 3.1 MyBatis Plus 常用注解及其功能说明 MyBatis Plus 是对 MyBatis 的增强封装,通过提供一系列常用注解简化了数据库操作,使得开发者无需编写 XML 文件即可完成实体类与数据库表之间的映射和操作。 #### 3.1.1 `@TableName` 该注解用于标识实体类对应的数据库表名。在默认情况下,MyBatis Plus 会将实体类的类名转换为小写作为表名进行操作。如果实际表名与类名不一致,则需要使用 `@TableName` 明确指定对应的表名。例如,当实体类名为 `User` 而实际表名为 `t_user` 时,可以通过如下方式定义: ```java @TableName("t_user") public class User { // 实体类字段定义 } ``` 这一做法解决了默认表名与实际数据库表名不匹配的问题[^4]。 #### 3.1.2 `@TableId` `@TableId` 注解用于标识主键字段,并可以设置主键类型。MyBatis Plus 支持多种主键生成策略,例如自增、UUID、雪花算法等。以下是一个使用 `@TableId` 指定主键并采用自增策略的示例: ```java @TableId(value = "id", type = IdType.AUTO) private Long id; ``` 上述代码中,`value` 表示数据库表中的主键字段名,`type` 表示主键类型,其中 `IdType.AUTO` 表示由数据库自动增长生成主键值[^3]。 #### 3.1.3 `@TableField` `@TableField` 注解用于标识普通字段,支持多种配置选项,如是否为数据库字段、字段名映射、是否自动填充等。例如,若实体类字段名与数据库列名不一致,可以通过 `@TableField` 指定对应关系: ```java @TableField("user_name") private String name; ``` 此外,`@TableField` 还支持自动填充功能,适用于创建时间和更新时间等字段的自动管理[^1]。 #### 3.1.4 全局配置与默认前缀 为了进一步减少重复注解的使用,MyBatis Plus 提供了全局配置功能。例如,可以通过配置文件为所有表名设置默认前缀,避免在每个实体类上添加 `@TableName` 注解。以下是一个典型的全局配置示例: ```yaml mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl global-config: db-config: table-prefix: t_ ``` 该配置表示所有表名默认以 `t_` 开头,从而实现统一的命名规范[^3]。 #### 3.1.5 `@Version`(乐观锁注解) `@Version` 注解用于实现乐观锁机制,防止多线程并发修改数据导致的数据不一致问题。通常应用于高并发场景下的数据更新操作。例如: ```java @Version private Integer version; ``` 在更新数据时,MyBatis Plus 会自动检查版本号是否发生变化,若发生变化则抛出异常,阻止更新操作,确保数据一致性。 #### 3.1.6 `@LogicDelete`(逻辑删除注解) `@LogicDelete` 注解用于实现逻辑删除功能,即在删除数据时不真正从数据库中移除记录,而是通过一个状态字段标记为已删除。例如: ```java @LogicDelete private Integer deleted; ``` 通过该注解,查询操作会自动过滤掉被标记为删除的记录,提升数据安全性与可恢复性[^2]。 --- ### 3.2 使用案例与注意事项 以下是一个完整的实体类示例,展示了多个常用注解的综合应用: ```java @TableName("t_user") public class User { @TableId(value = "id", type = IdType.AUTO) private Long id; @TableField("user_name") private String name; @TableField("email") private String email; @Version private Integer version; @LogicDelete private Integer deleted; // Getter 和 Setter 方法 } ``` 在此示例中: - `@TableName` 指定了表名为 `t_user`; - `@TableId` 定义了主键字段及其映射; - `@TableField` 用于非主键字段的映射; - `@Version` 启用了乐观锁机制; - `@LogicDelete` 实现了逻辑删除功能。 在实际开发过程中,合理使用这些注解可以显著减少 SQL 编写工作量,提升开发效率[^2]。 --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值