Spring JdbcTemplate整合使用方法及原理详解
基本配置
JdbcTemplate基本用法实际上很简单,开发者在创建一个SpringBoot项目时,除了选择基本的Web依赖,再记得选上Jdbc依赖,以及数据库驱动依赖即可,如下:
项目创建成功之后,记得添加Druid数据库连接池依赖(注意这里可以添加专门为SpringBoot打造的druid-spring-boot-starter,而不是我们一般在SSM中添加的Druid),所有添加的依赖如下:
com.alibaba druid-spring-boot-starter 1.1.10 org.springframework.boot spring-boot-starter-jdbc org.springframework.boot spring-boot-starter-web mysql mysql-connector-java 5.1.27 runtime
项目创建完后,接下来只需要在application.properties中提供数据的基本配置即可,如下:
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.username=root
spring.datasource.password=123
spring.datasource.url=jdbc:mysql:///test01?useUnicode=true&characterEncoding=UTF-8
如此之后,所有的配置就算完成了,接下来就可以直接使用JdbcTemplate了?咋这么方便呢?其实这就是SpringBoot的自动化配置带来的好处,我们先说用法,一会来说原理。
基本用法
首先我们来创建一个UserBean,如下:
publicclassUser{ privateLongid; privateStringusername; privateStringaddress; //省略getter/setter }
然后来创建一个UserService类,在UserService类中注入JdbcTemplate,如下:
@Service publicclassUserService{ @Autowired JdbcTemplatejdbcTemplate; }
好了,如此之后,准备工作就算完成了。
增
JdbcTemplate中,除了查询有几个API之外,增删改统一都使用update来操作,自己来传入SQL即可。例如添加数据,方法如下:
publicintaddUser(Useruser){ returnjdbcTemplate.update("insertintouser(username,address)values(?,?);",user.getUsername(),user.getAddress()); }
update方法的返回值就是SQL执行受影响的行数。
这里只需要传入SQL即可,如果你的需求比较复杂,例如在数据插入的过程中希望实现主键回填,那么可以使用PreparedStatementCreator,如下:
publicintaddUser2(Useruser){ KeyHolderkeyHolder=newGeneratedKeyHolder(); intupdate=jdbcTemplate.update(newPreparedStatementCreator(){ @Override publicPreparedStatementcreatePreparedStatement(Connectionconnection)throwsSQLException{ PreparedStatementps=connection.prepareStatement("insertintouser(username,address)values(?,?);",Statement.RETURN_GENERATED_KEYS); ps.setString(1,user.getUsername()); ps.setString(2,user.getAddress()); returnps; } },keyHolder); user.setId(keyHolder.getKey().longValue()); System.out.println(user); returnupdate; }
实际上这里就相当于完全使用了JDBC中的解决方案了,首先在构建PreparedStatement时传入Statement.RETURN_GENERATED_KEYS,然后传入KeyHolder,最终从KeyHolder中获取刚刚插入数据的id保存到user对象的id属性中去。
你能想到的JDBC的用法,在这里都能实现,Spring提供的JdbcTemplate虽然不如MyBatis,但是比起Jdbc还是要方便很多的。
删
删除也是使用updateAPI,传入你的SQL即可:
publicintdeleteUserById(Longid){ returnjdbcTemplate.update("deletefromuserwhereid=?",id); }
当然你也可以使用PreparedStatementCreator。
改
publicintupdateUserById(Useruser){ returnjdbcTemplate.update("updateusersetusername=?,address=?whereid=?",user.getUsername(),user.getAddress(),user.getId()); }
当然你也可以使用PreparedStatementCreator。
查
查询的话,稍微有点变化,这里主要向大伙介绍query方法,例如查询所有用户:
publicListgetAllUsers(){ returnjdbcTemplate.query("select*fromuser",newRowMapper (){ @Override publicUsermapRow(ResultSetresultSet,inti)throwsSQLException{ Stringusername=resultSet.getString("username"); Stringaddress=resultSet.getString("address"); longid=resultSet.getLong("id"); Useruser=newUser(); user.setAddress(address); user.setUsername(username); user.setId(id); returnuser; } }); }
查询的时候需要提供一个RowMapper,就是需要自己手动映射,将数据库中的字段和对象的属性一一对应起来,这样。。。。嗯看起来有点麻烦,实际上,如果数据库中的字段和对象属性的名字一模一样的话,有另外一个简单的方案,如下:
publicListgetAllUsers2(){ returnjdbcTemplate.query("select*fromuser",newBeanPropertyRowMapper<>(User.class)); }
至于查询时候传参也是使用占位符,这个和前文的一致,这里不再赘述。
其他
除了这些基本用法之外,JdbcTemplate也支持其他用法,例如调用存储过程等,这些都比较容易,而且和Jdbc本身都比较相似,这里也就不做介绍了,有兴趣可以留言讨论。
原理分析
那么在SpringBoot中,配置完数据库基本信息之后,就有了一个JdbcTemplate了,这个东西是从哪里来的呢?源码在
org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration类中,该类源码如下:
@Configuration @ConditionalOnClass({DataSource.class,JdbcTemplate.class}) @ConditionalOnSingleCandidate(DataSource.class) @AutoConfigureAfter(DataSourceAutoConfiguration.class) @EnableConfigurationProperties(JdbcProperties.class) publicclassJdbcTemplateAutoConfiguration{ @Configuration staticclassJdbcTemplateConfiguration{ privatefinalDataSourcedataSource; privatefinalJdbcPropertiesproperties; JdbcTemplateConfiguration(DataSourcedataSource,JdbcPropertiesproperties){ this.dataSource=dataSource; this.properties=properties; } @Bean @Primary @ConditionalOnMissingBean(JdbcOperations.class) publicJdbcTemplatejdbcTemplate(){ JdbcTemplatejdbcTemplate=newJdbcTemplate(this.dataSource); JdbcProperties.Templatetemplate=this.properties.getTemplate(); jdbcTemplate.setFetchSize(template.getFetchSize()); jdbcTemplate.setMaxRows(template.getMaxRows()); if(template.getQueryTimeout()!=null){ jdbcTemplate .setQueryTimeout((int)template.getQueryTimeout().getSeconds()); } returnjdbcTemplate; } } @Configuration @Import(JdbcTemplateConfiguration.class) staticclassNamedParameterJdbcTemplateConfiguration{ @Bean @Primary @ConditionalOnSingleCandidate(JdbcTemplate.class) @ConditionalOnMissingBean(NamedParameterJdbcOperations.class) publicNamedParameterJdbcTemplatenamedParameterJdbcTemplate( JdbcTemplatejdbcTemplate){ returnnewNamedParameterJdbcTemplate(jdbcTemplate); } } }
从这个类中,大致可以看出,当当前类路径下存在DataSource和JdbcTemplate时,该类就会被自动配置,jdbcTemplate方法则表示,如果开发者没有自己提供一个JdbcOperations的实例的话,系统就自动配置一个JdbcTemplateBean(JdbcTemplate是JdbcOperations接口的一个实现)。好了,不知道大伙有没有收获呢?
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。
声明:本文内容来源于网络,版权归原作者所有,内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:czq8825#qq.com(发邮件时,请将#更换为@)进行举报,并提供相关证据,一经查实,本站将立刻删除涉嫌侵权内容。