NamedParameterJdbcTemplate类拓展了JdbcTemplate类,对JdbcTemplate类进行了封装从而支持命名参数特性。

NamedParameterJdbcTemplate主要提供以下三类方法:execute方法、query及queryForXXX方法、update及batchUpdate方法。

数据库结构

NamedParameterJdbcTemplate常用方法总结 - 图1

支持类

SqlParameterSource 简介

可以使用SqlParameterSource实现作为来实现为命名参数设值,默认实现有 :

  1. MapSqlParameterSource实现非常简单,只是封装了java.util.Map;
  2. BeanPropertySqlParameterSource封装了一个JavaBean对象,通过JavaBean对象属性来决定命名参数的值。
  3. EmptySqlParameterSource 一个空的SqlParameterSource ,常用来占位使用

RowMapper简介

这个接口为了实现sql查询结果和对象间的转换,可以自己实现,也可以使用系统实现,主要实现类有:

  1. SingleColumnRowMapper ,sql结果为一个单列的数据,如List<String> ,List<Integer>,String,Integer
  2. BeanPropertyRowMapper, sql结果匹配到对象 List< XxxVO> , XxxVO

插入/修改/删除数据,使用updateXXX方法

使用Map作为参数

API: int update(String sql, Map<String, ?> paramMap)

示例:

  1. Map<String, Object> paramMap = new HashMap<>();
  2. paramMap.put("id", UUID.randomUUID().toString());
  3. paramMap.put("name", "小明");
  4. paramMap.put("age", 33);
  5. paramMap.put("homeAddress", "乐山");
  6. paramMap.put("birthday", new Date());
  7. template.update(
  8. "insert into student(id,name,age,home_address,birthday) values (:id,:name,:age,:homeAddress,:birthday)",
  9. paramMap
  10. );

使用BeanPropertySqlParameterSource作为参数

API: int update(String sql, SqlParameterSource paramSource)

示例

  1. public class StudentDTO{
  2. private String id;
  3. private String name;
  4. private String homeAddress;
  5. //getter,setter
  6. }
  1. StudentDTO dto=new StudentDTO();//这个DTO为传入数据
  2. dto.setId(UUID.randomUUID().toString());
  3. dto.setName("小红");
  4. dto.setHomeAddress("成都");
  5. //------------------------------
  6. template.update("insert into student(id,name,home_address) values (:id,:name,:homeAddress)",
  7. new BeanPropertySqlParameterSource(dto));

使用MapSqlParameterSource 作为参数

API:int update(String sql, SqlParameterSource paramSource)

  1. //使用 MapSqlParameterSource 作为参数
  2. MapSqlParameterSource mapSqlParameterSource = new MapSqlParameterSource()
  3. .addValue("id", UUID.randomUUID().toString())
  4. .addValue("name", "小王")
  5. .addValue("homeAddress", "美国");
  6. template.update("insert into student(id,name,home_address) values (:id,:name,:homeAddress)",mapSqlParameterSource);

或者

  1. Map<String, Object> paramMap = new HashMap<>();
  2. paramMap.put("id", UUID.randomUUID().toString());
  3. paramMap.put("name", "小明");
  4. paramMap.put("homeAddress", "乐山");
  5. //---------------
  6. MapSqlParameterSource mapSqlParameterSource = new MapSqlParameterSource(paramMap);

查询

返回单行单列数据

API: public < T > T queryForObject(String sql, Map<String, ?> paramMap, Class<T> requiredType)

API:public < T > T queryForObject(String sql, SqlParameterSource paramSource, Class<T> requiredType)

示例(注意EmptySqlParameterSource的使用):

  1. Integer count = template.queryForObject(
  2. "select count(*) from student", new HashMap<>(), Integer.class);
  1. String name = template.queryForObject( "select name from student where home_address limit 1 ", EmptySqlParameterSource.INSTANCE, String.class);

返回 (多行)单列数据

API: public < T> List< T> queryForList(String sql, Map<String, ?> paramMap, Class< T > elementType)

API: public < T> List< T> queryForList(String sql, SqlParameterSource paramSource, Class< T> elementType)

示例:

  1. List< String> namelist = template.queryForList("select name from student", new HashMap<>(), String.class);

返回单行数据

API: public < T> T queryForObject(String sql, Map< String, ?> paramMap, RowMapper< T>rowMapper)

API: public < T> T queryForObject(String sql, SqlParameterSource paramSource, RowMapper< T> rowMapper)

示例:

  1. Student stu = template.queryForObject(
  2. "select * from student limit 1", new HashMap<>(), new BeanPropertyRowMapper<Student>(Student.class));
  3. //BeanPropertyRowMapper会把下划线转化为驼峰属性
  4. //结果对象可比实际返回字段多或者少

注意:这两个API也可以使用SingleColumnRowMapper返回单行单列数据

  1. String name = template.queryForObject(
  2. "select name from student limit 1", EmptySqlParameterSource.INSTANCE, new SingleColumnRowMapper<>(String.class));

返回Map形式的单行数据

API: public Map< String, Object> queryForMap(String sql, Map< String, ?> paramMap)

API: public Map< String, Object> queryForMap(String sql, SqlParameterSource paramSource)

示例:

  1. Map< String, Object> studentMap = template.queryForMap("select * from student limit 1", new HashMap<>());

返回多行数据

API:public < T> List< T> query(String sql, Map< String, ?> paramMap, RowMapper< T> rowMapper)
API: public < T> List< T> query(String sql, SqlParameterSource paramSource, RowMapper< T> rowMapper)
API: public < T> List< T> query(String sql, RowMapper< T> rowMapper)

示例:

  1. List< Student> studentList = template.query(
  2. "select * from student",
  3. new BeanPropertyRowMapper<>(Student.class)
  4. );

同理,也可以使用SingleColumnRowMapper返回单行列表List< String>,List< Integer>等

返回多行数据(Map)

API: public List< Map< String, Object>> queryForList(String sql, Map< String, ?> paramMap)
API: public List< Map< String, Object>> queryForList(String sql, SqlParameterSource paramSource)

示例:

  1. List<Map<String, Object>> mapList = template.queryForList(
  2. "select * from student", new HashMap<>());

总结

  1. 开发中尽量使用NamedParameterJdbcTemplate代替JdbcTemplate,如果想使用JdbcTemplate,也可以通过NamedParameterJdbcTemplate#getJdbcOperations()获取
  2. 不建议使用查询结构为Map的API