Guide du langage d'expression Spring

1. Vue d'ensemble

Le Spring Expression Language (SpEL) est un langage d'expression puissant qui prend en charge l'interrogation et la manipulation d'un graphique d'objets au moment de l'exécution. Il peut être utilisé avec des configurations Spring basées sur XML ou annotations.

Il existe plusieurs opérateurs disponibles dans la langue:

Type Les opérateurs
Arithmétique +, -, *, /,%, ^, div, mod
Relationnel , ==,! =, =, lt, gt, eq, ne, le, ge
Logique et, ou, pas, &&, ||,!
Conditionnel ?:
Regex allumettes

2. Opérateurs

Pour ces exemples, nous utiliserons une configuration basée sur les annotations. Vous trouverez plus de détails sur la configuration XML dans les sections ultérieures de cet article.

Les expressions SpEL commencent par le symbole # et sont placées entre accolades: # {expression} . Les propriétés peuvent être référencées de la même manière, en commençant par un symbole $ , et placées entre accolades: $ {property.name} . Les espaces réservés de propriété ne peuvent pas contenir d'expressions SpEL, mais les expressions peuvent contenir des références de propriété:

#{${someProperty} + 2}

Dans l'exemple ci-dessus, supposons que someProperty a la valeur 2, donc l'expression résultante serait 2 + 2, qui serait évaluée à 4.

2.1. Opérateurs arithmétiques

Tous les opérateurs arithmétiques de base sont pris en charge.

@Value("#{19 + 1}") // 20 private double add; @Value("#{'String1 ' + 'string2'}") // "String1 string2" private String addString; @Value("#{20 - 1}") // 19 private double subtract; @Value("#{10 * 2}") // 20 private double multiply; @Value("#{36 / 2}") // 19 private double divide; @Value("#{36 div 2}") // 18, the same as for / operator private double divideAlphabetic; @Value("#{37 % 10}") // 7 private double modulo; @Value("#{37 mod 10}") // 7, the same as for % operator private double moduloAlphabetic; @Value("#{2 ^ 9}") // 512 private double powerOf; @Value("#{(2 + 2) * 2 + 9}") // 17 private double brackets; 

Les opérations de division et de modulo ont des alias alphabétiques, div pour / et mod pour % . L' opérateur + peut également être utilisé pour concaténer des chaînes.

2.2. Opérateurs relationnels et logiques

Toutes les opérations relationnelles et logiques de base sont également prises en charge.

@Value("#{1 == 1}") // true private boolean equal; @Value("#{1 eq 1}") // true private boolean equalAlphabetic; @Value("#{1 != 1}") // false private boolean notEqual; @Value("#{1 ne 1}") // false private boolean notEqualAlphabetic; @Value("#{1 < 1}") // false private boolean lessThan; @Value("#{1 lt 1}") // false private boolean lessThanAlphabetic; @Value("#{1  1}") // false private boolean greaterThan; @Value("#{1 gt 1}") // false private boolean greaterThanAlphabetic; @Value("#{1 >= 1}") // true private boolean greaterThanOrEqual; @Value("#{1 ge 1}") // true private boolean greaterThanOrEqualAlphabetic; 

Tous les opérateurs relationnels ont également des alias alphabétiques. Par exemple, dans les configurations basées sur XML, nous ne pouvons pas utiliser d'opérateurs contenant des chevrons ( < , <=, > , > = ). Au lieu de cela, nous pouvons utiliser lt (inférieur à), le (inférieur ou égal), gt (supérieur à) ou ge (supérieur ou égal).

2.3. Opérateurs logiques

SpEL prend en charge toutes les opérations logiques de base:

@Value("#") // true private boolean orAlphabetic; @Value("#{!true}") // false private boolean not; @Value("#{not true}") // false private boolean notAlphabetic;

Comme pour les opérateurs arithmétiques et relationnels, tous les opérateurs logiques ont également des clones alphabétiques.

2.4. Opérateurs conditionnels

Les opérateurs conditionnels sont utilisés pour injecter différentes valeurs en fonction de certaines conditions:

@Value("#{2 > 1 ? 'a' : 'b'}") // "a" private String ternary;

L'opérateur ternaire est utilisé pour exécuter une logique conditionnelle compacte if-then-else à l'intérieur de l'expression. Dans cet exemple, nous essayons de vérifier s'il y avait vrai ou non.

Une autre utilisation courante de l'opérateur ternaire est de vérifier si une variable est nulle , puis de renvoyer la valeur de la variable ou une valeur par défaut:

@Value("#{someBean.someProperty != null ? someBean.someProperty : 'default'}") private String ternary;

L'opérateur Elvis est un moyen de raccourcir la syntaxe de l'opérateur ternaire pour le cas ci-dessus utilisé dans le langage Groovy. Il est également disponible en SpEL. Le code ci-dessous est équivalent au code ci-dessus:

@Value("#{someBean.someProperty ?: 'default'}") // Will inject provided string if someProperty is null private String elvis;

2.5. Utilisation de Regex dans SpEL

L' opérateur matches peut être utilisé pour vérifier si une chaîne correspond ou non à une expression régulière donnée.

@Value("#{'100' matches '\\d+' }") // true private boolean validNumericStringResult; @Value("#{'100fghdjf' matches '\\d+' }") // false private boolean invalidNumericStringResult; @Value("#{'valid alphabetic string' matches '[a-zA-Z\\s]+' }") // true private boolean validAlphabeticStringResult; @Value("#{'invalid alphabetic string #$1' matches '[a-zA-Z\\s]+' }") // false private boolean invalidAlphabeticStringResult; @Value("#{someBean.someValue matches '\d+'}") // true if someValue contains only digits private boolean validNumericValue;

2.6. Accès aux objets Liste et Map

Avec l'aide de SpEL, nous pouvons accéder au contenu de n'importe quelle carte ou liste dans le contexte. Nous allons créer un nouveau bean workersHolder qui stockera des informations sur certains travailleurs et leurs salaires dans une liste et une carte :

@Component("workersHolder") public class WorkersHolder { private List workers = new LinkedList(); private Map salaryByWorkers = new HashMap(); public WorkersHolder() { workers.add("John"); workers.add("Susie"); workers.add("Alex"); workers.add("George"); salaryByWorkers.put("John", 35000); salaryByWorkers.put("Susie", 47000); salaryByWorkers.put("Alex", 12000); salaryByWorkers.put("George", 14000); } //Getters and setters }

Nous pouvons maintenant accéder aux valeurs des collections en utilisant SpEL:

@Value("#{workersHolder.salaryByWorkers['John']}") // 35000 private Integer johnSalary; @Value("#{workersHolder.salaryByWorkers['George']}") // 14000 private Integer georgeSalary; @Value("#{workersHolder.salaryByWorkers['Susie']}") // 47000 private Integer susieSalary; @Value("#{workersHolder.workers[0]}") // John private String firstWorker; @Value("#{workersHolder.workers[3]}") // George private String lastWorker; @Value("#{workersHolder.workers.size()}") // 4 private Integer numberOfWorkers;

3. Utilisation dans la configuration Spring

3.1. Référencer un Bean

Dans cet exemple, nous verrons comment utiliser SpEL dans une configuration XML. Les expressions peuvent être utilisées pour référencer des beans ou des champs / méthodes de haricots. Par exemple, supposons que nous ayons les classes suivantes:

public class Engine { private int capacity; private int horsePower; private int numberOfCylinders; // Getters and setters } public class Car { private String make; private int model; private Engine engine; private int horsePower; // Getters and setters }

Nous créons maintenant un contexte d'application dans lequel des expressions sont utilisées pour injecter des valeurs:

Jetez un coup d'œil au haricot someCar . Les champs engine et horsePower de someCar utilisent des expressions qui sont des références de bean respectivement aux champs engine bean et horsePower .

Pour faire de même avec les configurations basées sur des annotations, utilisez l' annotation @Value («# {expression}») .

3.2. Utilisation d'opérateurs dans la configuration

Each operator from the first section of this article can be used in XML and annotation-based configurations. However, remember that in XML-based configuration, we can't use the angle bracket operator “<“. Instead, we should use the alphabetic aliases, such as lt (less than) or le (less than or equals). For annotation-based configurations, there are no such restrictions.

public class SpelOperators { private boolean equal; private boolean notEqual; private boolean greaterThanOrEqual; private boolean and; private boolean or; private String addString; // Getters and setters
 @Override public String toString() { // toString which include all fields }

Now we will add a spelOperators bean to the application context:

   = 6}"/>   300 or someCar.engine.capacity > 3000}"/>

Retrieving that bean from the context, we can then verify that values were injected properly:

ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml"); SpelOperators spelOperators = (SpelOperators) context.getBean("spelOperators"); 

Here we can see the output of the toString method of spelOperators bean:

[equal=true, notEqual=false, greaterThanOrEqual=true, and=true, or=true, addString=Some model manufactured by Some make] 

4. Parsing Expressions Programmatically

At times, we may want to parse expressions outside the context of configuration. Fortunately, this is possible, using SpelExpressionParser. We can use all operators that we saw in previous examples but should use them without braces and hash symbol. That is, if we want to use an expression with the + operator when used in Spring configuration, the syntax is #{1 + 1}; when used outside of configuration, the syntax is simply 1 + 1.

In the following examples, we will use the Car and Engine beans defined in the previous section.

4.1. Using ExpressionParser

Let's look at a simple example:

ExpressionParser expressionParser = new SpelExpressionParser(); Expression expression = expressionParser.parseExpression("'Any string'"); String result = (String) expression.getValue(); 

ExpressionParser is responsible for parsing expression strings. In this example, SpEL parser will simply evaluate the string ‘Any String' as an expression. Unsurprisingly, the result will be ‘Any String'.

As with using SpEL in configuration, we can use it to call methods, access properties, or call constructors.

Expression expression = expressionParser.parseExpression("'Any string'.length()"); Integer result = (Integer) expression.getValue();

Additionally, instead of directly operating on the literal, we could call the constructor:

Expression expression = expressionParser.parseExpression("new String('Any string').length()");

We can also access the bytes property of String class, in the same way, resulting in the byte[] representation of the string:

Expression expression = expressionParser.parseExpression("'Any string'.bytes"); byte[] result = (byte[]) expression.getValue();

We can chain method calls, just as in normal Java code:

Expression expression = expressionParser.parseExpression("'Any string'.replace(\" \", \"\").length()"); Integer result = (Integer) expression.getValue();

In this case, the result will be 9, because we have replaced whitespace with the empty string. If we don't wish to cast the expression result, we can use the generic method T getValue(Class desiredResultType), in which we can provide the desired type of class that we want to be returned. Note that EvaluationException will be thrown if the returned value cannot be cast to desiredResultType:

Integer result = expression.getValue(Integer.class);

The most common usage is to provide an expression string that is evaluated against a specific object instance:

Car car = new Car(); car.setMake("Good manufacturer"); car.setModel("Model 3"); car.setYearOfProduction(2014); ExpressionParser expressionParser = new SpelExpressionParser(); Expression expression = expressionParser.parseExpression("model"); EvaluationContext context = new StandardEvaluationContext(car); String result = (String) expression.getValue(context);

In this case, the result will be equal to the value of the model field of the car object, “Model 3“. The StandardEvaluationContext class specifies which object the expression will be evaluated against.

It cannot be changed after the context object is created. StandardEvaluationContext is expensive to construct, and during repeated usage, it builds up cached state that enables subsequent expression evaluations to be performed more quickly. Because of caching it is good practice to reuse StandardEvaluationContext where it possible if the root object does not change.

However, if the root object is changed repeatedly, we can use the mechanism shown in the example below:

Expression expression = expressionParser.parseExpression("model"); String result = (String) expression.getValue(car);

Here, we call the getValue method with an argument that represents the object to which we want to apply a SpEL expression. We can also use the generic getValue method, just as before:

Expression expression = expressionParser.parseExpression("yearOfProduction > 2005"); boolean result = expression.getValue(car, Boolean.class);

4.2. Using ExpressionParser to Set a Value

Using the setValue method on the Expression object returned by parsing an expression, we can set values on objects. SpEL will take care of type conversion. By default, SpEL uses org.springframework.core.convert.ConversionService. We can create our own custom converter between types. ConversionService is generics aware, so it can be used with generics. Let's take a look how we can use it in practice:

Car car = new Car(); car.setMake("Good manufacturer"); car.setModel("Model 3"); car.setYearOfProduction(2014); CarPark carPark = new CarPark(); carPark.getCars().add(car); StandardEvaluationContext context = new StandardEvaluationContext(carPark); ExpressionParser expressionParser = new SpelExpressionParser(); expressionParser.parseExpression("cars[0].model").setValue(context, "Other model");

The resulting car object will have modelOther model” which was changed from “Model 3“.

4.3. Parser Configuration

In the following example, we will use the following class:

public class CarPark { private List cars = new ArrayList(); // Getter and setter }

It is possible to configure ExpressionParser by calling the constructor with a SpelParserConfiguration object. For example, if we try to add car object into the cars array of CarPark class without configuring the parser, we will get an error like this:

EL1025E:(pos 4): The collection has '0' elements, index '0' is invalid

We can change the behavior of the parser, to allow it to automatically create elements if the specified index is null (autoGrowNullReferences, the first parameter to the constructor), or to automatically grow an array or list to accommodate elements beyond its initial size (autoGrowCollections, the second parameter).

SpelParserConfiguration config = new SpelParserConfiguration(true, true); StandardEvaluationContext context = new StandardEvaluationContext(carPark); ExpressionParser expressionParser = new SpelExpressionParser(config); expressionParser.parseExpression("cars[0]").setValue(context, car); Car result = carPark.getCars().get(0);

The resulting car object will be equal to the car object which was set as the first element of the cars array of carPark object from the previous example.

5. Conclusion

SpEL est un langage d'expression puissant et bien pris en charge qui peut être utilisé sur tous les produits du portefeuille Spring. Il peut être utilisé pour configurer des applications Spring ou pour écrire des analyseurs pour effectuer des tâches plus générales dans n'importe quelle application.

Les exemples de code de cet article sont disponibles dans le référentiel GitHub lié.