SpringData JPA的常用语法汇总

前言

springdata jpa常用有两种写法，一个是用jpa自带方法进行crud，适合简单查询场景、例如查询全部数据、根据某个字段查询，根据某字段排序等等。另一种是使用注解方式，@query、@modifying。

1.方法方式

方法说明

接口方法如下，方法作用见注释：

public interface jparepository<t, id> extends pagingandsortingrepository<t, id>, querybyexampleexecutor<t> {
    // 无条件，查询全部记录
    list<t> findall();
    // 排序查询
    list<t> findall(sort var1);
    // 根据主键id查询
    list<t> findallbyid(iterable<id> var1);
    // 批量保存集合数据
    <s extends t> list<s> saveall(iterable<s> var1);

    void flush();
 
    <s extends t> s saveandflush(s var1);
    // 批量删除
    void deleteinbatch(iterable<t> var1);
    // all in 全部删除
    void deleteallinbatch();
    // 查询一条记录
    t getone(id var1);
    // 条件查询
    <s extends t> list<s> findall(example<s> var1);
    // 条件查询，带排序
    <s extends t> list<s> findall(example<s> var1, sort var2);
}

例子

一般dao实现jparepository接口，直接调用jparepository中的方法就可以实现了简单查询，例如查询user实例列表：

// 构建user的example对象
example<user> example =example.of(user);
list<user> users = userrepository.findall(example);

2.注解方式

jpa实现crud的主要注解是@query

注解说明

@query注解主要有以下参数，参数作用如下：

• value：sql语句
• countquery: 分页查询时统计总数
• nativequery: 使用执行这个方法的时候执行原生sql语句，直接写数据库中的实际表名和表的实际字段名

@query的代码如下：

@retention(retentionpolicy.runtime)
@target({elementtype.method, elementtype.annotation_type})
@queryannotation
@documented
public @interface query {
    string value() default "";
    string countquery() default "";
    string countprojection() default "";
    boolean nativequery() default false;
    string name() default "";
    string countname() default "";
}

例子

• 使用注解方式分组查询

跟正常写sql语句相同，将sql写到value中，并且nativequery = true。下面例子是根据task_id进行分组查询task集合

@query(value = "select task_id from task group by task_id", nativequery = true)
list<task> querybygroup();

• 使用注解方式排序

根据task_id进行排序查询task集合

@query(value = "select task_id,task_date from task order by task_id", nativequery = true)
list<task> queryorder();

• 使用注解方式条件查询

条件查询时可以使用字段名 操作符 ?；例如：task_date >= ?，使用位置匹配?。也可以使用字段名 操作符 :属性名；例如：task_date >= :startdate，使用属性名匹配，推荐使用后者，如果字段顺序修改，不影响匹配结果。下面是根据任务时间（task_date）段内和未被删除(deleted)的任务

@query(value = "select task_id,task_date from task where task_date >=? and task_date <=? and deleted=0 ", nativequery = true)
list<appttask> querydate(@param("startdate") string startdate, @param("enddate") string enddate);

• 使用注解方式修改

修改一条数据需要加上@modifying用于标识是修改操作，默认事务等级是只读，所以还需要加上@transactional，这样覆盖了默认的@transactional才可以执行修改操作。下面是根据task_id更新task表的备注信息

@transactional(rollbackon = exception.class)
@modifying
@query(value = "update task set remark = ? where task_id=?", nativequery = true)
void updateremark(@param("remark") string remark, @param("taskid") string taskid);

多表联查，且多条件、分页查询怎么写？

复杂的查询需要注意，以下使用一个mysql的多表联查的例子来说明复杂的查询要怎么写。下面是user表task表关联查询出任务名称、任务id、用户名称这些信息，并且根据task_name、task_date进行过滤；根据task_date倒序。

共有几点需要注意：

• 多表联查使用正常的join就可以
• 多条件是常见的情况，需要区别传入的条件是否要去执行，这种情况需要使用where 1=1 and 这种方式来保证条件不传时仍然正常查询。
• 分页查询需要传入分页参数pageable,并且写countquery来统计总数。
• 多条件查询关键：if(:参数!='',k.字段名 =:参数,1=1)，这里是使用了if进行判断，这个写法类似mybatis xml中的<if>标签。if的含义是代表传入的参数如果不为""（spring类型空是""而不是null）将参数传入，如果为空时显示1=1 代表参数为真，对查询结果不产生作用。

代码：

@query(value =
      " select a.task_name, a.task_id,u.user_name" +
      " from task a " +
      " left join usert u" +
      " on a.user_id = u.user_id" +
      " where  a.deleted=0  " +
      " and if(:taskname!='',a.task_name =:taskname,1=1)" +
      " and if(:startdate!='',a.task_date >=:startdate,1=1)" +
      " and if(:enddate!='',a.task_date <=:enddate,1=1)" +
      " order by a.task_date desc"
      , 
      nativequery = true
      , 
      countquery =
      " select count(*)" +
      " from task a " +
      " left join usert u" +
      " on a.user_id = u.user_id" +
      " where  a.deleted=0  " +
      " and if(:taskname!='',a.task_name =:taskname,1=1)" +
      " and if(:startdate!='',a.task_date >=:startdate,1=1)" +
      " and if(:enddate!='',a.task_date <=:enddate,1=1)" +
      " order by a.task_date desc")
page<map<string,object>> queryusertaskpage(@param("taskname") string taskname, @param("startdate") localdate startdate, @param("enddate") localdate enddate, @param("pageable") pageable pageable);

小结

以上列举了两种jpa的crud方式，jpa方法与注解方式，平时写代码时更倾向于使用注解方式去写原生sql来实现业务。对于简单查询可以用jparepository里面这些方法就够用了，对于更复杂的场景推荐使用@query写sql的方式来实现。

jpa方法可以屏蔽底层的sql，如果有不同数据库实现的服务，用jpa方法可以免于修改sql。但是jpa方法对于分组查询、limit支持、多条件、多表联查这些不太友好。

总结

到此这篇关于springdata jpa常用语法的文章就介绍到这了,更多相关springdata jpa常用语法内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！