@Before advice in Spring Boot - Mini Project: Build & Apply

Using @Before Advice in Spring Boot

📖 Scenario: You are building a Spring Boot application that logs a message before any method in a service class runs. This helps track when methods start executing.

🎯 Goal: Create an aspect with @Before advice that logs a message before methods in the MyService class execute.

📋 What You'll Learn

Create a service class called MyService with a method performTask().

Create an aspect class called LoggingAspect.

Add a @Before advice in LoggingAspect that runs before performTask() method.

The advice should log the message "Starting performTask method".

💡 Why This Matters

🌍 Real World

Logging method calls helps monitor application behavior and debug issues in real time.

💼 Career

Understanding AOP and advice like <code>@Before</code> is essential for building maintainable and modular Spring Boot applications.

1

Create the service class with a method

Create a class called MyService with a public method performTask() that returns void and has an empty body.

Spring Boot

public class MyService {
    // Your code here
}

Hint

Define a public class named MyService. Inside it, add a public method performTask with no parameters and void return type.

2

Create the aspect class

Create a class called LoggingAspect and annotate it with @Aspect and @Component.

Spring Boot

import org.springframework.stereotype.Service;

@Service
public class MyService {
    public void performTask() {
        // method body
    }
}

// Your code here

Hint

Import @Aspect and @Component. Annotate the class LoggingAspect with both annotations.

3

Add @Before advice to log before performTask

Inside LoggingAspect, add a method logBefore() annotated with @Before that matches execution of performTask() in MyService. Inside the method, add a line to log the message "Starting performTask method" using System.out.println.

Spring Boot

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

@Aspect
@Component
public class LoggingAspect {
    // Your code here
}

Hint

Use @Before with the pointcut expression execution(void MyService.performTask()). Inside the advice method, print the log message.

4

Enable aspect processing in Spring Boot

In your Spring Boot application main class, add the annotation @EnableAspectJAutoProxy above the class declaration to enable aspect support.

Spring Boot

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

@Aspect
@Component
public class LoggingAspect {
    @Before("execution(void MyService.performTask())")
    public void logBefore() {
        System.out.println("Starting performTask method");
    }
}

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
// Your code here
@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

Hint

Import and add @EnableAspectJAutoProxy above your main application class to activate aspect support.

Practice

1. What is the main purpose of the @Before advice in Spring AOP?

easy

A. To replace the matched method entirely

B. To run code right before the matched method executes

C. To run code after the matched method completes

D. To handle exceptions thrown by the matched method

Solution

1. Step 1: Understand the role of @Before advice

   @Before advice is designed to execute code just before the target method runs.

2. Step 2: Compare with other advice types

   @After runs after method completion, @Around can replace, and @AfterThrowing handles exceptions.

3. Final Answer:

   To run code right before the matched method executes -> Option B

4. Quick Check:

   @Before advice = runs before method [OK]

Hint: Remember: @Before means before method starts [OK]

Common Mistakes:

• Confusing @Before with @After or @Around advice
• Thinking @Before replaces the method
• Assuming @Before handles exceptions

2. Which of the following is the correct syntax to define a @Before advice method in Spring AOP?

easy

A. @Before("execution(* com.example.service.*.*(..))") public void logBefore() {}

B. @Before public void logBefore() { execution(* com.example.service.*.*(..)); }

C. @Before public void logBefore() execution(* com.example.service.*.*(..)) {}

D. @Before("logBefore()") public void execution(* com.example.service.*.*(..)) {}

Solution

1. Step 1: Identify correct @Before annotation usage

   The @Before annotation requires a pointcut expression as a string parameter inside parentheses and quotes.

2. Step 2: Check method signature and placement

   The method should be public void with no parameters or with JoinPoint if needed, and the pointcut is inside @Before("...").

3. Final Answer:

   @Before("execution(* com.example.service.*.*(..))") public void logBefore() {} -> Option A

4. Quick Check:

   @Before("pointcut") public void method() {} [OK]

Hint: Look for @Before with pointcut string in parentheses [OK]

Common Mistakes:

• Placing pointcut expression outside quotes
• Missing parentheses after @Before
• Incorrect method signature or missing public

3. Given the following code snippet, what will be printed when service.process() is called?

@Aspect
@Component
public class LoggingAspect {
  @Before("execution(* com.example.service.Service.process(..))")
  public void beforeProcess() {
    System.out.println("Before process");
  }
}

@Service
public class Service {
  public void process() {
    System.out.println("Processing");
  }
}

medium

A. Before process\nProcessing

B. Processing\nBefore process

C. Before process

D. Processing

Solution

1. Step 1: Understand @Before advice execution timing

   @Before advice runs before the matched method, so "Before process" prints first.

2. Step 2: Analyze method call output

   Then the actual method prints "Processing" after the advice.

3. Final Answer:

   Before process\nProcessing -> Option A

4. Quick Check:

   @Before prints first, then method output [OK]

Hint: @Before prints before method output [OK]

Common Mistakes:

• Assuming method prints before advice
• Thinking advice replaces method output
• Ignoring advice execution order

4. Identify the error in this @Before advice definition:

@Before("execution(* com.example..*(..))")
public void beforeMethod() {
  System.out.println("Before method");
}

medium

A. Advice method cannot have a body

B. Pointcut expression syntax is invalid

C. Method must return a value

D. Missing @Aspect annotation on the class

Solution

1. Step 1: Check class-level annotations

   For @Before advice to work, the class must be annotated with @Aspect to mark it as an aspect.

2. Step 2: Validate pointcut and method

   The pointcut expression is valid, and advice methods can have bodies and return void.

3. Final Answer:

   Missing @Aspect annotation on the class -> Option D

4. Quick Check:

   @Aspect missing = advice won't run [OK]

Hint: Always add @Aspect on the class with advice [OK]

Common Mistakes:

• Forgetting @Aspect on the aspect class
• Assuming advice methods must return values
• Misreading pointcut syntax errors

5. You want to log a message before any method in com.example.repository package is called, but only for methods starting with save. Which @Before pointcut expression correctly matches this?

hard

A. @Before("execution(* com.example.repository.save*(..))")

B. @Before("execution(* com.example.repository.*save*(..))")

C. @Before("execution(* com.example.repository..save*(..))")

D. @Before("execution(* com.example.repository.*.save*(..))")

Solution

1. Step 1: Understand pointcut syntax for package, class, and method

   To match methods starting with 'save' in any class of the com.example.repository package, use execution(* com.example.repository.*.save*(..)). However, if you want to include subpackages as well, use '..' instead of a single '*'.

2. Step 2: Analyze each option

   A matches only methods named save* in the package directly (no class wildcard), B is invalid syntax, C matches methods in any class in the package but not subpackages, D matches methods starting with save in the package and all subpackages.

3. Final Answer:

   @Before("execution(* com.example.repository..save*(..))") -> Option C

4. Quick Check:

   package..save*(..) = matches package and subpackages [OK]

Hint: Use package..save* to include subpackages and methods starting with save [OK]

Common Mistakes:

• Using incorrect wildcards or dots in method name
• Matching subpackages unintentionally
• Misplacing wildcards in pointcut expression