![](/img/trans.png)
[英]How create Get method with path variable and field value other than id ? (Spring Jpa Hibernate Rest)
[英]JPA: How to get entity based on field value other than ID?
在JPA(Hibernate)中,当我们自动生成ID字段时,假设用户不知道这个key。 因此,在获取实体时,用户会根据ID以外的某些字段进行查询。 在那种情况下我们如何获得实体(因为不能使用em.find()
)。
我知道我们可以使用查询并稍后过滤结果。 但是,有没有更直接的方法(因为据我了解这是一个非常普遍的问题)。
这不是您所说的“问题”。
Hibernate 具有内置的find()
,但您必须构建自己的查询才能获取特定对象。 我建议使用Hibernate的Criteria
:
Criteria criteria = session.createCriteria(YourClass.class);
YourObject yourObject = criteria.add(Restrictions.eq("yourField", yourFieldValue))
.uniqueResult();
这将在您当前的类上创建一个criteria
,添加列“yourField”等于值yourFieldValue
。 uniqueResult()
告诉它带来一个独特的结果。 如果更多的对象匹配,你应该检索一个列表。
List<YourObject> list = criteria.add(Restrictions.eq("yourField", yourFieldValue)).list();
如果您有任何其他问题,请随时提问。 希望这可以帮助。
基本上,您应该添加一个特定的唯一字段。 我通常使用xxxUri
字段。
class User {
@Id
// automatically generated
private Long id;
// globally unique id
@Column(name = "SCN", nullable = false, unique = true)
private String scn;
}
你的商业方法会这样做。
public User findUserByScn(@NotNull final String scn) {
CriteriaBuilder builder = manager.getCriteriaBuilder();
CriteriaQuery<User> criteria = builder.createQuery(User.class);
Root<User> from = criteria.from(User.class);
criteria.select(from);
criteria.where(builder.equal(from.get(User_.scn), scn));
TypedQuery<User> typed = manager.createQuery(criteria);
try {
return typed.getSingleResult();
} catch (final NoResultException nre) {
return null;
}
}
最佳实践是使用 @NaturalId 注释。 在某些情况下它可以用作业务键它太复杂了,因此在现实世界中某些字段用作标识符。 例如,我有一个以用户 ID 作为主键的用户类,电子邮件也是唯一的字段。 所以我们可以使用电子邮件作为我们的自然 ID
@Entity
@Table(name="user")
public class User {
@Id
@Column(name="id")
private int id;
@NaturalId
@Column(name="email")
private String email;
@Column(name="name")
private String name;
}
要获得我们的记录,只需简单地使用“session.byNaturalId()”
Session session = sessionFactory.getCurrentSession();
User user = session.byNaturalId(User.class)
.using("email","huchenhai@qq.com")
.load()
这个解决方案来自Beginning Hibernate书:
Query<User> query = session.createQuery("from User u where u.scn=:scn", User.class);
query.setParameter("scn", scn);
User user = query.uniqueResult();
编写一个这样的自定义方法:
public Object findByYourField(Class entityClass, String yourFieldValue)
{
CriteriaBuilder criteriaBuilder = entityManager.getCriteriaBuilder();
CriteriaQuery<Object> criteriaQuery = criteriaBuilder.createQuery(entityClass);
Root<Object> root = criteriaQuery.from(entityClass);
criteriaQuery.select(root);
ParameterExpression<String> params = criteriaBuilder.parameter(String.class);
criteriaQuery.where(criteriaBuilder.equal(root.get("yourField"), params));
TypedQuery<Object> query = entityManager.createQuery(criteriaQuery);
query.setParameter(params, yourFieldValue);
List<Object> queryResult = query.getResultList();
Object returnObject = null;
if (CollectionUtils.isNotEmpty(queryResult)) {
returnObject = queryResult.get(0);
}
return returnObject;
}
我解决了一个类似的问题,我想通过 isbnCode 而不是你的 id(主键)来查找一本书。
@Entity
public class Book implements Serializable {
private static final long serialVersionUID = 1L;
@Id
@GeneratedValue(strategy=GenerationType.IDENTITY)
private Integer id;
private String isbnCode;
...
在存储库中,该方法是像提到的@kamalveer singh 一样创建的。 请注意,方法名称是 findBy+fieldName(在我的例子中:findByisbnCode):
@Repository
public interface BookRepository extends JpaRepository<Book, Integer> {
Book findByisbnCode(String isbnCode);
}
然后,在服务中实现方法:
@Service
public class BookService {
@Autowired
private BookRepository repo;
public Book findByIsbnCode(String isbnCode) {
Book obj = repo.findByisbnCode(isbnCode);
return obj;
}
}
不,您不需要进行条件查询,这将是样板代码,如果您在 Spring-boot 中工作,您只需做简单的事情:在您的存储库中使用 findBy[exact field name] 声明一个方法名称。 示例 - 如果您的模型或文档包含一个字符串字段myField并且您想通过它查找,那么您的方法名称将是:
findBymyField(String myField);
看一下:
JPA query language
: Java 持久性查询语言JPA Criteria API
:使用 Criteria API 创建查询我写了一个库,可以帮助做到这一点。 它允许通过仅初始化您要过滤的字段来按对象进行搜索: https : //github.com/kg6zvp/GenericEntityEJB
在我的 Spring Boot 应用程序中,我解决了类似的问题:
@Autowired
private EntityManager entityManager;
public User findByEmail(String email) {
User user = null;
Query query = entityManager.createQuery("SELECT u FROM User u WHERE u.email=:email");
query.setParameter("email", email);
try {
user = (User) query.getSingleResult();
} catch (Exception e) {
// Handle exception
}
return user;
}
参考 - 查询方法的 Spring 文档
我们可以通过在如下方法中传递 diff 参数来在 Spring Jpa 中添加方法:
List<Person> findByEmailAddressAndLastname(EmailAddress emailAddress, String lastname);
// Enabling static ORDER BY for a query
List<Person> findByLastnameOrderByFirstnameAsc(String lastname);
编辑:刚刚意识到@Chinmoy 基本上是在做同样的事情,但我想我可能做得更好 ELI5 :)
如果您使用 Spring Data 的一种风格来帮助从您定义的任何类型的Repository
持久化/获取事物,您可能可以让您的 JPA 提供者通过一些巧妙的技巧为您执行此操作,并在您的Repository
接口类中使用方法名称。 请允许我解释一下。
(作为免责声明,我刚才做了/仍在为自己解决这个问题。)
例如,如果我在我的数据库中存储令牌,我可能有一个如下所示的实体类:
@Data // << Project Lombok convenience annotation
@Entity
public class Token {
@Id
@Column(name = "TOKEN_ID")
private String tokenId;
@Column(name = "TOKEN")
private String token;
@Column(name = "EXPIRATION")
private String expiration;
@Column(name = "SCOPE")
private String scope;
}
而且我可能有一个像这样定义的CrudRepository<K,V>
接口,以便免费为我提供对该存储库的简单 CRUD 操作。
@Repository
// CrudRepository<{Entity Type}, {Entity Primary Key Type}>
public interface TokenRepository extends CrudRepository<Token, String> { }
例如,当我查找这些令牌之一时,我的目的可能是检查过期或范围。 在这两种情况中的任何一种情况下,我可能都没有方便的tokenId
,而只是我想要查找的token
字段本身的值。
为此,您可以巧妙地向TokenRepository
接口添加一个额外的方法,以告诉您的 JPA 提供者您传递给该方法的值不是tokenId
,而是 Entity 类中另一个字段的值,它应该在生成将针对您的数据库运行的实际 SQL 时考虑到这一点。
@Repository
// CrudRepository<{Entity Type}, {Entity Primary Key Type}>
public interface TokenRepository extends CrudRepository<Token, String> {
List<Token> findByToken(String token);
}
我在Spring Data R2DBC 文档页面上读到了这个,到目前为止它似乎在存储在嵌入式 H2 数据库中的 SpringBoot 2.x 应用程序中工作。
所有的答案都要求您编写某种 SQL/HQL/任何东西。 为什么? 您不必 - 只需使用CriteriaBuilder
:
人.java :
@Entity
class Person {
@Id @GeneratedValue
private int id;
@Column(name = "name")
private String name;
@Column(name = "age")
private int age;
...
}
道.java :
public class Dao {
public static Person getPersonByName(String name) {
SessionFactory sessionFactory = new Configuration().configure().buildSessionFactory();
Session session = sessionFactory.openSession();
session.beginTransaction();
CriteriaBuilder cb = session.getCriteriaBuilder();
CriteriaQuery<Person> cr = cb.createQuery(Person.class);
Root<Person> root = cr.from(Person.class);
cr.select(root).where(cb.equal(root.get("name"), name)); //here you pass a class field, not a table column (in this example they are called the same)
Query<Person> query = session.createQuery(cr);
query.setMaxResults(1);
List<Person> result = query.getResultList();
session.close();
return result.get(0);
}
}
使用示例:
public static void main(String[] args) {
Person person = Dao.getPersonByName("John");
System.out.println(person.getAge()); //John's age
}
这是非常基本的查询:
实体:学生
@Entity
@Data
@NoArgsConstructor
public class Student{
@Id
@GeneratedValue(generator = "uuid2", strategy = GenerationType.IDENTITY)
@GenericGenerator(name = "uuid2", strategy = "uuid2")
private String id;
@Column(nullable = false)
@Version
@JsonIgnore
private Integer version;
private String studentId;
private String studentName;
private OffsetDateTime enrollDate;
}
存储库接口: StudentRepository
@Repository
public interface StudentRepository extends JpaRepository<Student, String> {
List<Student> findByStudentName(String studentName);
List<Student> findByStudentNameOrderByEnrollDateDesc(String studentName);
@Transactional
@Modifying
void deleteByStudentName(String studentName);
}
注意:findByColumnName:按条件给出结果
List findByStudentName(String studentName) 内部转换成query: select * from Student where name='studentName'
@Transactional @Modifying当您想从数据库中删除持久数据时很有用。
使用 CrudRepository 和 JPA 查询对我有用:
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.query.Param;
public interface TokenCrudRepository extends CrudRepository<Token, Integer> {
/**
* Finds a token by using the user as a search criteria.
* @param user
* @return A token element matching with the given user.
*/
@Query("SELECT t FROM Token t WHERE LOWER(t.user) = LOWER(:user)")
public Token find(@Param("user") String user);
}
然后像这样调用 find 自定义方法:
public void destroyCurrentToken(String user){
AbstractApplicationContext context = getContext();
repository = context.getBean(TokenCrudRepository.class);
Token token = ((TokenCrudRepository) repository).find(user);
int idToken = token.getId();
repository.delete(idToken);
context.close();
}
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.