java - 带有注入(inject)服务的 REST 端点 - 在哪里抛出自定义 WebServiceException？

Question

我有已注入(inject)服务的 REST 端点。

@Singleton
@Path("/v1/service")
public class MyService {

    @Inject
    private TokenService tokenService;

    @Inject
    private InfoService infoService;

    @GET
    @Path("/info")
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public InfoResponse getInfo(@HeaderParam("Authorization") String token){

        tokenService.validateToken(token);

        List<String> info = infoService.getInfo();

        // processing info code, throwing WebServiceException if something wrong

       return new InfoResponse(info);
    }
}

其中一些验证数据，例如 token ，如果不正确则抛出 RestServiceException 异常。异常由 ExceptionMapper 处理，因此返回适当的响应。其他服务返回/处理信息。

我的自定义异常类带有附加字段:

public class RestServiceException extends WebServiceException {

    public Integer httpStatus;

    public String message;
}

服务方法示例:

public User getUser(Long userId){

    User user = userMapper.getUser(userId);

    if (user == null){
        String msg = "Invalid user: " + userId;
        logger.debug(msg);
        throw new RestServiceException(HttpStatus.SC_NOT_FOUND, InternalStatus.INVALID_USER, msg);
    }

    return user;
}

在注入(inject)的服务中抛出 RestServiceException 是好的做法吗？如何设计代码方便测试？在哪里放置验证方法 - 服务还是静态类？

Answer 1

Is good practice to throw WebServiceException in injected services?

我不会。

1. 使服务不可在 jax-rs 应用程序之外重用(对您来说可能不是什么大问题)。

2. 打破了“分层”架构规则；下层不应该知道上层的任何事情。如果您想包装在 WebApplicationException 中，您应该只抛出一个正常的服务级别异常，然后从那里捕获资源中的异常。 ，然后这样做。

   也许只是抛出一个WebApplicationException不被认为是“了解上层”，但我个人认为确实如此，因为异常类型特定于该上层。

How to design code to facilitate testing?

使用构造函数注入(inject)而不是字段注入(inject)。如果需要，可以更轻松地为资源提供模拟服务。

public class MyService {

    private final TokenService tokenService;
    private final InfoService infoService;

    @Inject
    public MyService(TokenService tokenService,
                     InfoService infoService) {
        this.tokenService = tokenService;
        this.infoService = infoService;
    }
}

Where to put validation methods - service or static class?

这确实没有意义。如果“静态类”指的是单例模式单例，那么绝对不是这样。按照您当前的方式使用控制反转是更好的选择。

<小时/>

更新

我想我读错了你的问题。出于某种原因，我读了你的 WebServiceException作为 JAX-RS WebApplicationException .

我想我上面提到的规则不适用。但我可能会将异常的名称更改为 WebServiceException 以外的名称。这将它与上“网络”层紧密联系在一起。将异常命名为该服务特定的名称。

关于在资源级别处理异常，如果您不想，则无需对其执行任何操作，如果 ExceptionMapper正在处理它。或者，如果您愿意，您也可以捕获它并将其包装在 WebApplicationException 中。 .

您可以查看 this post 的底部，其中列出了 WebApplicationException 的所有子类。如果需要，您可以将异常包装在其中之一中并抛出它。这些异常都映射到状态代码。