Hibernate: Avoid using column names as strings

Question

I would like to avoid having column names as strings in the code. Is there any other way to accomplish this?:

String query = "SELECT c.foo1.columnA, c.foo1.foo2.columnB FROM Table c";
session.createQuery(query).list();

I'm able to iterate over a column as string like c.foo1.foo2.columnB by splitting and getting the ClassMetadata, the property Type and other Hibernate functions until I reach the last element. However, I can't think a way to get a column string from Java beans, iterating through properties too.

My advice: leave your code as is. It's much more readable this way. Implement unit tests to make sure your queries are valid, and do what they're supposed to do. Use named queries so that they're validated at deployment time. — JB Nizet
– JB Nizet, Commented Jul 8, 2015 at 15:08
But they're not column names. They're class property names of your entities. And you're not selecting from a specific table either, you're querying for entity instances. This reads like an X/Y problem - why exactly do you want to make the property names variable? You want to re-use the same query for different entities perhaps? — Gimby
– Gimby, Commented Jul 8, 2015 at 15:19
Actually, I had to restructure some tables and columns in a DB. Thus, I had to change my Java beans. However, I also have to search through all the code for queries that use some changed column. Therefore, I wanted to know if there is a better way to approach this. — IvanRF
– IvanRF, Commented Jul 8, 2015 at 15:31

Community · Accepted Answer · 2017-05-23 12:16:15Z

1

Not sure what is the intention. Couple of thoughts

If you are worried about possibility of property names being wrong, current day IDEs does a good job by validating the property names in JPA queries

Object reflection can give you the property names. But not necessarily all properties are mapped to columns. You can look at this and use it along with bean property names via reflection.

Hope that helps.

edited May 23, 2017 at 12:16

CommunityBot

11 silver badge

answered Jul 8, 2015 at 15:22

Rakesh Kumar Cherukuri

1,27112 silver badges25 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

marc_s · Accepted Answer · 2018-11-26 17:03:06Z

0

There is no way to achieve what you are looking for. But, if your concern is correctness of these queries and worry that the problem will not be known until the execution hits this, you could use NamedQuery

@Entity
@NamedQuery(
    name="findAllEmployeesByFirstName",
    queryString="SELECT OBJECT(emp) FROM Employee emp WHERE emp.firstName = 'John'"
)

public class Employee implements Serializable {
...
}

Usage

List employees = em.createNamedQuery("findAllEmployeesByFirstName").getResultList();

The benefit is that queries defined in NamedQuery annotations are compiled to actual SQL at start up time. So incorrect field references(typo etc) will cause a start up error and the application will not start.

Another option will be as mentioned in the other answer to trust in a good IDE to refactor all occurrences properly when you rename fields (Idea does a great job at this, so would any other IDE)

EDIT: I do not think there is any performance degradation with named queries. Rather it may appear to be faster as compiled queries are cached(very subjective)

Finally, its better to use the actual query as-is as mentioned in comments. It is far more readable and debug in its context. If you are concerned about correctness, unit-test the heck out of it and be confident.

edited Nov 26, 2018 at 17:03

marc_s

760k186 gold badges1.4k silver badges1.5k bronze badges

answered Jul 8, 2015 at 15:39

ring bearer

20.9k8 gold badges62 silver badges73 bronze badges

2 Comments

IvanRF Over a year ago

If by using NamedQuery I get start up errors, it will be a huge improvement to my code. I feel like string queries are prone to execution errors. Thanks!

IvanRF Over a year ago

Is there any hit on performance for the queries compilation at start up?

Collectives™ on Stack Overflow

Hibernate: Avoid using column names as strings

2 Answers 2

Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related