如何制作 REST 控制器的模式

Question

我正在编写我的第一个 Spring 应用程序，并希望获得经验以在 Spring 上编写最佳且有吸引力的代码。 我有一些 restcontrollers 有很大一部分类似的代码

   @RequestMapping(path = "/1154",
                method = RequestMethod.POST,
                headers = {"Content-Type=application/json"},
                consumes = MediaType.APPLICATION_JSON_UTF8_VALUE,
                produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

        public CreateUserResp processRequest(@RequestBody @Valid CreateUserReq request, BindingResult bindingResult) {

            CreateUserResp response = new CreateUserResp();

            if (bindingResult.hasErrors()){

                response.setResultCode(102); // Validation error
                response.setErrMsg("Wrong " + bindingResult.getFieldError().getDefaultMessage() + " value.");

            } else {
                   // main service
                   request = UserService.doSomething();

            }
            return response;
        }

 @RequestMapping(path = "/1155",
                method = RequestMethod.POST,
                headers = {"Content-Type=application/json"},
                consumes = MediaType.APPLICATION_JSON_UTF8_VALUE,
                produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

        public ChangeUserResp processRequest(@RequestBody @Valid ChangeUserReq request, BindingResult bindingResult) {

            ChangeUserResp response = new ChangeUserResp();

            if (bindingResult.hasErrors()){

                response.setResultCode(102); // Validation error
                response.setErrMsg("Wrong " + bindingResult.getFieldError().getDefaultMessage() + " value.");

            } else {
                   // main service
                   request = ChangeService.doSomething();

            }
            return response;
        }

 @RequestMapping(path = "/1156",
                method = RequestMethod.POST,
                headers = {"Content-Type=application/json"},
                consumes = MediaType.APPLICATION_JSON_UTF8_VALUE,
                produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

        public AddUserResp processRequest(@RequestBody @Valid AddUserReq request, BindingResult bindingResult) {

            AddUserResp response = new AddUserResp();

            if (bindingResult.hasErrors()){

                response.setResultCode(102); // Validation error
                response.setErrMsg("Wrong " + bindingResult.getFieldError().getDefaultMessage() + " value.");

            } else {
                   // main service
                   request = AddService.doSomething();

            }
            return response;
        }

 @RequestMapping(path = "/1157",
                method = RequestMethod.POST,
                headers = {"Content-Type=application/json"},
                consumes = MediaType.APPLICATION_JSON_UTF8_VALUE,
                produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

        public ModifyUserResp processRequest(@RequestBody @Valid ModifyUserReq request, BindingResult bindingResult) {

            ModifyUserResp response = new ModifyUserResp();

            if (bindingResult.hasErrors()){

                response.setResultCode(102); // Validation error
                response.setErrMsg("Wrong " + bindingResult.getFieldError().getDefaultMessage() + " value.");

            } else {
                   // main service
                   request = ModifyService.doSomething();

            }
            return response;
        }

等等……

（路径、@RequestBody 和 Responce 对象以及称为 service 的唯一区别）。所以，我将有 10-12 个这样的控制器。是否可以使此代码更优化而不是编写此可重复的代码块 10 次（弹簧方法或可能使用泛型类或方法）。这只是示例，不是真正的代码。谢谢

特别感谢那些忙于回答但有时间减号的人。

Answer 1

我的应用程序中有一些非常相似的东西。

例如，这就是我在用户控制器中的 editProfile 方法的样子：

@PostMapping(value = EDIT_CONTACT_INFO)
public ResponseEntity<?> editContactInfo(
        @Autowired HttpServletRequest httpServletRequest,
        @RequestBody @Valid ContactInfoDTO.Req requestBody,
        BindingResult bindingResult
)
{
    if (bindingResult.hasErrors())
        // 400 - BAD REQUEST
        return ErrorsDTO.from(bindingResult).responseEntity();

    String userName = ControllerUtils.getUserName(httpServletRequest);
    User user =  userService.findByUserName(userName);
    ContactInfo contactInfo = modelMapper.map(requestBody, ContactInfo.class);

    if (!userService.editContactInfo(user, contactInfo))
        // 500 - INTERNAL SERVER ERROR
        return ErrorsDTO.from(INTERNAL_SERVER_ERROR).responseEntity();

    // 200 - OK
    return ResponseEntity.ok(null);
}

我的大部分 API 看起来和你的很相似。我刚刚编写了我的自定义机制来报告错误，并使用ResponseEntity 实例返回数据。

我还有一个库可以将数据从 DTO 传递到我的模型并返回（它称为 ModelMapper）。

Answer 2

编辑：看起来这篇博文涵盖了您的问题： http://blog.codeleak.pl/2013/09/request-body-validation-in-spring-mvc-3.2.html

---

如果你真的想搞砸，你可以写一个拦截器，在一个新的注解ValidateBinding上有一个切入点和一个BindingResult的参数。它可能看起来像：

@Around("@annotation(ValidateBinding) && execution(* *(..)) && args(bindingResult)
public Object handleInvalidBindings(ProceedingJoinPoint p, BindingResult bindingResult) {

    if (bindingResult.hasErrors()){
        GenericResponse response = createTypedResponse(p);
        response.setResultCode(102); // Validation error
        response.setErrMsg("Wrong " + bindingResult.getFieldError().getDefaultMessage() + " value.");
        return response;
    } 
    return pjp.proceed();
}

private GenericResponse createTypedResponse(ProceedingJoinPoint p) {
    MethodSignature signature = (MethodSignature) p.getSignature();
    Method method = signature.getMethod();
    Class responseClass = method.getReturnType();
    if(!GenericResponse.class.isAssignableFrom(responseClass)) {
        throw new IllegalArgumentException("Could not create proper response class - it should implement the GenericResponse interface");
    return (GenericResponse) responseClass.newInstance();
}

但我不保证表达式或代码有效。这是对其外观的粗略猜测。

为此，您需要一个接口 GenericResponse，它由您的响应类实现，并具有 setResultCode 和 setErrMsg。