Pointcut expressions in Spring Boot

Introduction

Pointcut expressions help you pick specific places in your code to add extra behavior without changing the original code.

You want to log every time a method in a service class runs.

You need to check user permissions before certain methods execute.

You want to measure how long some methods take to run.

You want to handle errors in a consistent way across many methods.

Syntax

Spring Boot

execution(modifiers-pattern? ret-type-pattern declaring-type-pattern? method-name-pattern(param-pattern) throws-pattern?)

The execution keyword is the most common way to write pointcut expressions.

Use * as a wildcard to match any part, like any method name or any return type.

Examples

Matches any method in any class inside the com.example.service package.

Spring Boot

execution(* com.example.service.*.*(..))

Matches any public method regardless of class or package.

Spring Boot

execution(public * *(..))

Matches any method starting with find in UserRepository class.

Spring Boot

execution(* com.example.repository.UserRepository.find*(..))

Matches methods starting with delete that take a single Long parameter and return void in controller package.

Spring Boot

execution(void com.example.controller.*.delete*(Long))

Sample Program

This example shows a logging aspect that runs before any method in the com.example.service package. When createUser runs, the aspect prints a message first.

Spring Boot

package com.example.aop;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class LoggingAspect {

    @Before("execution(* com.example.service.*.*(..))")
    public void logBefore() {
        System.out.println("A method in service package is about to run.");
    }
}

// Sample service class
package com.example.service;

import org.springframework.stereotype.Service;

@Service
public class UserService {
    public void createUser() {
        System.out.println("User created.");
    }
}

// Main application to run
package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import com.example.service.UserService;

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        ApplicationContext context = SpringApplication.run(DemoApplication.class, args);
        UserService userService = context.getBean(UserService.class);
        userService.createUser();
    }
}

Important Notes

Pointcut expressions are very flexible and can match many method patterns.

Be careful with wildcards to avoid matching too many methods unintentionally.

Use Spring Boot DevTools or your IDE debugger to test if your pointcuts are working as expected.

Summary

Pointcut expressions select where extra code runs without changing original methods.

Use execution() with wildcards to match methods by name, package, or parameters.

They help add logging, security, or other features cleanly and easily.

Practice

1. What does a pointcut expression in Spring Boot primarily do?

easy

A. Create new methods dynamically at runtime

B. Define the database connection settings

C. Select methods where extra code (advice) should run

D. Replace existing methods with new implementations

Solution

1. Step 1: Understand the purpose of pointcut expressions

   Pointcut expressions specify where additional code, called advice, should be applied in existing methods without changing those methods.

2. Step 2: Differentiate from other concepts

   They do not create or replace methods, nor configure databases. Their role is to select join points (methods) for advice.

3. Final Answer:

   Select methods where extra code (advice) should run -> Option C

4. Quick Check:

   Pointcut expression = Select methods for advice [OK]

Hint: Pointcuts pick methods to add code without changing them [OK]

Common Mistakes:

• Confusing pointcuts with method creation
• Thinking pointcuts configure databases
• Believing pointcuts replace method code

2. Which of the following is the correct syntax to match all methods in package com.example.service using a pointcut expression?

easy

A. execution(* com.example.service..*(..))

B. execution(com.example.service.*.*(..))

C. execution(* com.example.service.*(..))

D. execution(* com.example.service.*.*(..))

Solution

1. Step 1: Understand the execution syntax

   The syntax execution(* com.example.service.*.*(..)) matches any return type, any class in the package com.example.service, and any method with any parameters.

2. Step 2: Analyze other options

   execution(com.example.service.*.*(..)) misses the wildcard for return type. execution(* com.example.service..*(..)) uses double dot .. which matches subpackages, not just the package. execution(* com.example.service.*(..)) misses the class wildcard.

3. Final Answer:

   execution(* com.example.service.*.*(..)) -> Option D

4. Quick Check:

   Use * for any class and method in package [OK]

Hint: Use * for any class and method in a package [OK]

Common Mistakes:

• Omitting the return type wildcard *
• Using .. instead of * for classes
• Missing method wildcard *

3. Given the pointcut expression execution(public * com.example.repo.*Repository.find*(..)), which methods will it match?

medium

A. All methods named 'find' in any class in com.example.repo

B. All public methods starting with 'find' in any class ending with 'Repository' in package com.example.repo

C. All public methods in any class in com.example.repo

D. Only methods named exactly 'find' in any class ending with 'Repository'

Solution

1. Step 1: Break down the expression

   public * means any public return type, com.example.repo.*Repository matches classes ending with 'Repository' in the package, and find*(..) matches methods starting with 'find' with any parameters.

2. Step 2: Match options to expression meaning

   All public methods starting with 'find' in any class ending with 'Repository' in package com.example.repo correctly describes all public methods starting with 'find' in classes ending with 'Repository' in the package. Others are either too broad or too narrow.

3. Final Answer:

   All public methods starting with 'find' in any class ending with 'Repository' in package com.example.repo -> Option B

4. Quick Check:

   execution(public * com.example.repo.*Repository.find*(..)) = All public methods starting with 'find' in any class ending with 'Repository' in package com.example.repo [OK]

Hint: Look for wildcards * and method name patterns carefully [OK]

Common Mistakes:

• Ignoring method name prefix 'find*'
• Confusing class name pattern *Repository
• Missing public modifier effect

4. Identify the error in this pointcut expression: execution(* com.example..service.*(..)

medium

A. Missing closing parenthesis at the end

B. Incorrect use of double dots '..' in package name

C. Wildcard '*' cannot be used for method names

D. Return type '*' is invalid

Solution

1. Step 1: Check syntax completeness

   The expression is missing a closing parenthesis ')' at the end, which is required to close the execution() expression.

2. Step 2: Validate other parts

   Double dots '..' are valid to match subpackages, '*' is valid for method names, and '*' is valid for return type.

3. Final Answer:

   Missing closing parenthesis at the end -> Option A

4. Quick Check:

   Check parentheses balance in execution() [OK]

Hint: Count parentheses carefully in pointcut expressions [OK]

Common Mistakes:

• Forgetting closing parenthesis
• Misunderstanding '..' usage
• Thinking '*' is invalid for methods or return types

5. You want to create a pointcut expression that matches all methods in any class within com.app.service and its subpackages, but only methods that have exactly two parameters of any type. Which expression is correct?

hard

A. execution(* com.app.service..*.*(*, *))

B. execution(* com.app.service.*.*(..))

C. execution(* com.app.service..*.*(.., ..))

D. execution(* com.app.service..*.*(*))

Solution

1. Step 1: Understand package and subpackage matching

   com.app.service..* matches classes in the package and all subpackages.

2. Step 2: Match method parameters exactly

   (* , *) means exactly two parameters of any type. (..) means any number of parameters, so it's incorrect here.

3. Step 3: Analyze options

   execution(* com.app.service..*.*(*, *)) correctly matches all classes in package and subpackages with exactly two parameters. Others either match any number of parameters or wrong parameter counts.

4. Final Answer:

   execution(* com.app.service..*.*(*, *)) -> Option A

5. Quick Check:

   Use (*, *) for exactly two parameters [OK]

Hint: Use (*, *) to match exactly two parameters [OK]

Common Mistakes:

• Using (..) to match exact parameter count
• Confusing single * with .. for subpackages
• Missing commas between parameters