将异常消息包含在JSON错误响应中。

huangapple
go评论96阅读模式
英文:

Include exception message in JSON error response

问题

如果电子邮件地址已存在，则抛出异常并附带消息（"消息：" + tempEmailId + "的用户已存在"）。当我在Postman中进行测试时，我无法获取异常消息。你能帮我解决一下吗？问题出在哪里？

控制器类：

  1. @RestController
  2. public class RegistrationController {
  4.     @Autowired
  5.     private RegistrationService service;
  7.     @PostMapping("/registeruser")
  8.     public User registerUser(@RequestBody User user) throws Exception {
  10.         String tempEmailId = user.getEmailId();
  11.         if (tempEmailId != null && !"".equals(tempEmailId)) {
  12.             User userObject = service.fetchUserByEmailId(tempEmailId);
  13.             if (userObject != null) {
  14.                 throw new Exception("用户" + tempEmailId + "已存在");
  15.             }
  16.         }
  17.         User userObject = null;
  18.         userObject = service.saveUser(user);
  19.         return userObject;
  21.     }
  22. }

存储库：

  1. public interface RegistrationRepository extends JpaRepository<User, Integer> {
  3.     public User findByEmailId(String emailId);  // 在这里声明
  4. }

服务：

  1. @Service
  2. public class RegistrationService {
  4.     @Autowired
  5.     private RegistrationRepository repo;
  7.     public User saveUser(User user) {
  8.         return repo.save(user);
  9.     }
  11.     public User fetchUserByEmailId(String email) {
  12.         return repo.findByEmailId(email);
  13.     }
  14. }
英文:

If email address already exists then throw an exception with a message("message:"User with "+tempEmailId+" already exists"). I don't get my exception message when I test in postman. Can you please help me ? Where is the issue? 将异常消息包含在JSON错误响应中。

Controller class:

  1. @RestController
  2. public class RegistrationController {
  4. 	@Autowired
  5. 	private RegistrationService service;
  6. 	
  7. 	@PostMapping(&quot;/registeruser&quot;)
  8. 	public  User registerUser(@RequestBody User user) throws Exception {
  9. 		
  10. 		String tempEmailId = user.getEmailId();
  11. 		if(tempEmailId !=null &amp;&amp; !&quot;&quot;.equals(tempEmailId)) {
  12. 			User userObject = service.fetchUserByEmailId(tempEmailId);
  13. 			if(userObject!=null) {
  14. 				throw new Exception(&quot;User with &quot;+tempEmailId+&quot; is already exist&quot;);
  15. 			}
  16. 		}
  17. 		User userObject = null;
  18. 		userObject = service.saveUser(user);
  19. 		return userObject;
  21. 	}
  22. }

Repository:

  1. public interface RegistrationRepository extends JpaRepository&lt;User, Integer&gt; {
  3. 	public User findByEmailId(String emailId);  // Here we declare 
  4. }

Service:

  1. @Service
  3. public class RegistrationService {
  5. 	@Autowired 
  6. 	private RegistrationRepository repo;
  7. 	
  8. 	public User saveUser(User user) {
  9. 		return repo.save(user);
  10. 	}
  11. 	
  12. 	public User fetchUserByEmailId(String email) { 
  13. 		return repo.findByEmailId(email);   
  14. 	}
  15. }

答案1

得分: 6

如果您使用的是Spring Boot 2.3版本或更高版本，则必须将属性server.error.include-message设置为always：

摘自Spring Boot 2.3发布说明：

默认错误页面内容的更改

默认情况下，错误消息和任何绑定错误不再包含在默认错误页面中。这减少了向客户端泄露信息的风险。server.error.include-message和server.error.include-binding-errors可用于控制是否包含消息和绑定错误。支持的值为always、on-param和never。

英文:

If you are using Spring Boot version 2.3 or higher, the property server.error.include-message must be set to always:

Quoted from Spring Boot 2.3 Release Notes:

> Changes to the Default Error Page’s Content
>
> The error message and any binding errors are no longer included in the default error page by default. This reduces the risk of leaking information to a client. server.error.include-message and server.error.include-binding-errors can be used to control the inclusion of the message and binding errors respectively. Supported values are always, on-param, and never.

答案2

得分: 0

你可以将你的控制器响应包装为 ResponseEntity。

  1. @PostMapping("/registeruser")
  2. public ResponseEntity<Object> registerUser(@RequestBody User user) throws Exception {
  3.     String tempEmailId = user.getEmailId();
  4.     if (tempEmailId != null && !tempEmailId.isEmpty()) {
  5.         User userObject = service.fetchUserByEmailId(tempEmailId);
  6.         if (userObject != null) {
  7.             return new ResponseEntity<>("用户 " + tempEmailId + " 已存在", HttpStatus.BAD_REQUEST);
  8.         }
  9.     }
  10.     return new ResponseEntity<>(service.saveUser(user), HttpStatus.OK);
  11. }

或者（更可取的方式）你可以创建一个特定的异常，比如 UserAlreadyExistException，在控制器中抛出它，并在带有 @RestControllerAdvice 注解的类中拦截它。
例如：

  1. @RestControllerAdvice
  2. public class RegistrationControllerAdvice {
  4.     @ExceptionHandler({UserAlreadyExistException.class})
  5.     @ResponseStatus(HttpStatus.BAD_REQUEST)
  6.     public String userAlreadyExist(UserAlreadyExistException ex, WebRequest req) {
  7.         return ex.getMessage();
  8.     }
  9. }

你可以返回任何可序列化为 JSON 的数据结构，而不仅仅是字符串。

英文:

You can wrap your controller responses to ResponseEntity.

  1. @PostMapping(&quot;/registeruser&quot;)
  2. public  ResponseEntity&lt;Object&gt; registerUser(@RequestBody User user) throws Exception {
  3.         String tempEmailId = user.getEmailId();
  4.         if(tempEmailId != null &amp;&amp; !tempEmailId.isEmpty()) {
  5.             User userObject = service.fetchUserByEmailId(tempEmailId);
  6.             if(userObject!=null) {
  7.                 return new ResponseEntity&lt;&gt;(&quot;User with &quot;+tempEmailId+&quot; is already exist&quot;, HttpStatus.BAD_REQUEST);
  8.             }
  9.         }
  10.         return new ResponseEntity&lt;&gt;(service.saveUser(user), HttpStatus.OK);
  11. }

Or (preferable variant) your can create specific exception, for example UserAlreadyExistException, throw it in controller and intercept in class annotated with @RestControllerAdvice.
For example:

  1. @RestControllerAdvice
  2. public class RegistrationControllerAdvice {
  4.     @ExceptionHandler({UserAlreadyExistException.class})
  5.     @ResponseStatus(HttpStatus.BAD_REQUEST)
  6.     public String userAlreadyExist(UserAlreadyExistException ex, WebRequest req) {
  7.         return ex.getMessage();
  8.     }
  9. }

Instead of String you can return any data structure serializable to JSON.

huangapple
  • 本文由 发表于 2020年9月9日 16:14:33
  • 转载请务必保留本文链接：https://go.coder-hub.com/63807464.html
  • java
  • jpa
  • spring
  • spring-boot
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定