首页 > 文章列表 > Spring Boot怎么整合JdbcTemplate

Spring Boot怎么整合JdbcTemplate

springboot jdbctemplate
214 2023-05-14

Spring Boot怎么整合JdbcTemplate

整合JdbcTemplate

JdbcTemplate 是 Spring 提供的一套 JDBC 模板框架,利用 AOP 技术来解决直接使用 JDBC 时大量重复代码的问题。JdbcTemplate 虽然没有 Mybatis 灵活,但是比直接使用 JDBC 方便很多。Spring Boot 中对 JdbcTemplate 的使用提供了自动化配置类 JdbcTemplateAutoConfiguration,部分源码如下:

@Configuration

@ConditionalOnClass({DataSource.class, JdbcTemplate.class})

@ConditionalOnSingleCandidate(DataSource.class)

@AutoConfigureAfter({DataSourceAutoConfiguration.class})

@EnableConfigurationProperties({JdbcProperties.class})

public class JdbcTemplateAutoConfiguration {

    public JdbcTemplateAutoConfiguration() {

    }

    @Configuration

    @Import({JdbcTemplateAutoConfiguration.JdbcTemplateConfiguration.class})

    static class NamedParameterJdbcTemplateConfiguration {

        NamedParameterJdbcTemplateConfiguration() {

        }

        @Bean

        @Primary

        @ConditionalOnSingleCandidate(JdbcTemplate.class)

        @ConditionalOnMissingBean({NamedParameterJdbcOperations.class})

        public NamedParameterJdbcTemplate namedParameterJdbcTemplate(JdbcTemplate jdbcTemplate) {

            return new NamedParameterJdbcTemplate(jdbcTemplate);

        }

    }

    @Configuration

    static class JdbcTemplateConfiguration {

        private final DataSource dataSource;

        private final JdbcProperties properties;



        JdbcTemplateConfiguration(DataSource dataSource, JdbcProperties properties) {

            this.dataSource = dataSource;

            this.properties = properties;

        }

        @Bean

        @Primary

        @ConditionalOnMissingBean({JdbcOperations.class})

        public JdbcTemplate jdbcTemplate() {

            JdbcTemplate jdbcTemplate = new JdbcTemplate(this.dataSource);

            Template template = this.properties.getTemplate();

            jdbcTemplate.setFetchSize(template.getFetchSize());

            jdbcTemplate.setMaxRows(template.getMaxRows());

            if (template.getQueryTimeout() != null) {

                jdbcTemplate.setQueryTimeout((int)template.getQueryTimeout().getSeconds());

            }

            return jdbcTemplate;

        }

    }

}

从源码中看出,当 classpath 下存在 DataSource 和 JdbcTemplate 并且 DataSource 只有一个实例时,自动配置才会生效,若开发者没有提供 JdbcOperations ,则 Spring Boot 会自动向容器中注入一个 JdbcTemplate (JdbcTemplate 是 JdbcOperations 的子类)。因此,开发者想使用 JdbcTemplate 只需要提供 JdbcTemplate 的依赖和 DataSource 依赖即可

创建数据库和表

在数据库中创建表,如下:

CREATE TABLE `book` (

  `id` int(11) NOT NULL AUTO_INCREMENT,

  `name` varchar(128) DEFAULT NULL,

  `author` varchar(128) DEFAULT NULL,

  PRIMARY KEY (`id`)

) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;

INSERT INTO `chapter05`(`id`, `name`, `author`) VALUES (1, '斗罗大陆Ⅰ', '唐家三少');

INSERT INTO `chapter05`(`id`, `name`, `author`) VALUES (2, '斗罗大陆Ⅱ', '唐家三少');

创建项目

创建 Spring Boot 项目 ,添加依赖

<dependency>

  <groupId>org.springframework.boot</groupId>

  <artifactId>spring-boot-starter-jdbc</artifactId>

</dependency>

<dependency>

  <groupId>org.springframework.boot</groupId>

  <artifactId>spring-boot-starter-web</artifactId>

</dependency>

<dependency>

  <groupId>mysql</groupId>

  <artifactId>mysql-connector-java</artifactId>

  <scope>runtime</scope>

</dependency>

<dependency>

  <groupId>com.alibaba</groupId>

  <artifactId>druid</artifactId>

  <version>1.1.9</version>

</dependency>

spring-boot-starter-jdbc 中提供了 spring-jdbc,另外还加入了数据库驱动依赖和数据库连接池依赖

数据库配置

在application.properties 中配置数据库基本连接信息

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource

spring.datasource.url=jdbc:mysql://localhost:3306/weirdo

spring.datasource.username=root

spring.datasource.password=root

创建实体类

创建 Book 实体类,代码如下:

public class Book {

    private int id;

    private String name;

    private String author;

    public int getId() {

        return id;

    }

    public void setId(int id) {

        this.id = id;

    }

    public String getName() {

        return name;

    }

    public void setName(String name) {

        this.name = name;

    }

    public String getAuthor() {

        return author;

    }

    public void setAuthor(String author) {

        this.author = author;

    }

}

创建数据库访问层

创建 BookDao,代码如下:

@Repository

public class BookDao {

    @Autowired

    JdbcTemplate jdbcTemplate;

    public int addBook(Book book) {

        return jdbcTemplate.update("INSERT INTO book(name,author) VALUES (?,?)",

                book.getName(), book.getAuthor());

    }

    public int updateBook(Book book) {

        return jdbcTemplate.update("UPDATE book SET name=?,author=? WHERE id=?",

                book.getName(), book.getAuthor(), book.getId());

    }

    public int deleteBookById(Integer id) {

        return jdbcTemplate.update("DELETE FROM book WHERE id=?", id);

    }

    public Book getBookById(Integer id) {

        return jdbcTemplate.queryForObject("select * from book where id=?",

                new BeanPropertyRowMapper<>(Book.class), id);

    }

    public List<Book> getAllBooks() {

        return jdbcTemplate.query("select * from book",

                new BeanPropertyRowMapper<>(Book.class));

    }

}

代码解释:

  • 创建 BookDao ,注入 jdbcTemplate 。由于已经添加了 spring-jdbc 相关依赖, JdbcTemplate 会被自动注册到 Spring 容器中,因此这里可以直接注入 JdbcTemplate 使用

  • 在 JdbcTemplate 中,增删改三种类型的操作主要使用 update 和 batchUpdate 方法来完成,query 和 queryForObject 方法主要用来完成查询功能。另外,还有 execute 方法可以用来执行任意的sql、call 方法用来调用存储过程等

  • 在执行查询操作时,需要有一个 RowMapper 将查询出来的列和实体类中的属性一一对应。如果列名和属性名是相同的,那么可以直接使用 BeanPropertyRowMapper;如果列名和属性名不同,需要开发者自己实现 RowMapper 接口,将列和实体类属性一一对应起来

创建 Service 和 Controller

创建 BookService 和 BooKController

@Service

public class BookService {

    @Autowired

    BookDao bookDao;

    public int addBook(Book book) {

        return bookDao.addBook(book);

    }

    public int updateBook(Book book) {

        return bookDao.updateBook(book);

    }

    public int deleteBookById(Integer id) {

        return bookDao.deleteBookById(id);

    }

    public Book getBookById(Integer id) {

        return bookDao.getBookById(id);

    }

    public List<Book> getAllBooks() {

        return bookDao.getAllBooks();

    }

}
@RestController

public class BookController {

    @Autowired

    BookService bookService;

    @GetMapping("/bookOps")

    public void bookOps() {

        Book b1 = new Book();

        b1.setId(99);

        b1.setName("西厢记");

        b1.setAuthor("王实甫");

        int i = bookService.addBook(b1);

        System.out.println("addBook>>>" + i);

        Book b2 = new Book();

        b2.setId(1);

        b2.setName("朝花夕拾");

        b2.setAuthor("鲁迅");

        int updateBook = bookService.updateBook(b2);

        System.out.println("updateBook>>>"+updateBook);

        Book b3 = bookService.getBookById(1);

        System.out.println("getBookById>>>"+b3);

        int delete = bookService.deleteBookById(2);

        System.out.println("deleteBookById>>>"+delete);

        List<Book> allBooks = bookService.getAllBooks();

        System.out.println("getAllBooks>>>"+allBooks);

    }

}

最后在浏览器中访问 http://localhost:8081/bookOps 地址,控制台打印日志如下:

addBook>>>1

updateBook>>>1

getBookById>>>com.sang.Book@35e33288

deleteBookById>>>1

getAllBooks>>>[com.sang.Book@2f7c2d6d, com.sang.Book@32db4b36]

数据库中的数据如下: