自定义注解和springAOP捕获Service层异常,并处理自定义异常操作

下面是关于自定义注解和Spring AOP结合进行Service层异常捕获并处理自定义异常操作的攻略。

1. 自定义注解

在Java的语言中，注解是一种元数据，它提供了一种在类、接口、字段、方法等的声明语句中添加元数据的方法。注解可以被标记为编译时的元数据或运行时的元数据。

自定义注解可以根据业务需求进行定义，其中注解应该只用于描述类、方法和变量等方面的信息，不能包含业务逻辑。

下面是一个自定义注解的示例代码：

@Target(ElementType.METHOD) //该注解作用于方法上
@Retention(RetentionPolicy.RUNTIME) //该注解在运行时也可用
public @interface ExceptionLog{
}

通过这个注解可以记录Service层方法的异常信息，在方法调用时进行捕获。

2. Spring AOP捕获Service层异常

在Spring框架中，AOP可以用来实现横向关注点分离的技术，比如日志记录、性能测试、事务管理等。而在Service层中，我们也可以通过AOP技术来进行异常捕获和处理。

下面是一个Spring AOP实现Service层异常捕获的示例代码：

@Aspect
@Component
public class ExceptionLogAspect {

    @Autowired
    private HttpServletRequest request;

    @Autowired
    private HttpServletResponse response;

    @Around("@annotation(ExceptionLog)") //通过注解来捕获方法异常信息
    public Object around(ProceedingJoinPoint point) throws Throwable {
        Object result = null;  

        try {
            result = point.proceed();
        } catch (Exception e) {
            //自定义异常处理
            if (e instanceof ServiceException) {
                ServiceException se = (ServiceException) e;               
                response.sendError(se.getErrorCode(), se.getMessage());
                return null;
            }
            //其他异常处理
            else {
                response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "系统内部错误");
                return null;
            }
        }

        return result;
    }  
}

在上述实现中，我们首先通过@Aspect和@Component来标明这个类是一个Aspect切面，Spring启动的时候会进行自动扫描。

然后通过@Around注解指定捕捉方法，@annotation指定注解类型。在方法执行过程中，通过try-catch来捕获Service层发生的异常，并根据自定义异常类型或其他异常类型进行不同的处理。

3. 示例说明

下面提供两个例子，分别涉及到了自定义注解和Spring AOP的使用：

3.1 自定义注解示例

一个例子是记录Controller层的操作日志。我们可以创建一个@OperationLog自定义注解，并应用到Controller的方法上，用于记录用户的操作日志。

自定义注解代码如下：

@Target(ElementType.METHOD) //该注解作用于方法上
@Retention(RetentionPolicy.RUNTIME) //该注解在运行时也可用
public @interface OperationLog{
    String value() default "";
}

然后将这个注解应用到Controller的方法上：

@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @OperationLog("用户登录系统")
    @PostMapping("/users/login")
    public JsonResponse login(@RequestBody LoginRequest request) {
        //...
    }

    //...
}

当用户发送登录请求时，OperationLogAspect会自动将@OperationLog注解上的描述信息记录下来，保存到日志文件中。

3.2 Spring AOP示例

我们可以创建一个自定义异常类型ServiceException，并在Service层方法中抛出它。在Spring的AOP中，通过@Around注解捕获Service层方法的异常，将自定义异常类型和其他异常类型分别进行处理。

我们来看一个简单的示例代码：

@Service
public class UserServiceImpl implements UserService {

    @Override
    public void assignRole(Long userId, Long roleId) {
        try {
            //...
            if (user == null || role == null) {
                throw new ServiceException("用户或角色不存在");
            }
            //...
        } catch (Exception e) {
            throw new ServiceException("分配角色失败");
        }
    }
}

ServiceException是自定义的异常类型。在assignRole方法中，我们先判断用户和角色是否存在，如果不存在，则抛出一个自定义异常。在try-catch语句外面，我们会将其他所有的异常都包装成ServiceException类型，然后重新抛出。

然后在Spring的配置文件中，配置ExceptionLogAspect切面：

<aop:aspectj-autoproxy proxy-target-class="true"/>

<bean id="exceptionLogAspect" class="com.example.aspect.ExceptionLogAspect"/>

最后，在Controller层中调用assignRole方法：

@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @PostMapping("/users/{id}/roles/{roleId}")
    public JsonResponse assignRole(@PathVariable("id") Long userId,
                                    @PathVariable("roleId") Long roleId) {
        userService.assignRole(userId, roleId);
        return JsonResponse.success(null);
    }

    //...
}

通过AOP技术，我们可以在Service层方法调用前后进行一些日志记录、事务管理等操作，从而实现更加灵活有用的功能。