response-boxing-starter: The project only simply boxing a special pattern for response result. Now, you can add timestamp to response result when you set timestamp plugin is true. And then, you can define any exception of extending DefaultAbstratException class, and throw them if you want anywhere. The code will capture them, responsing a unified exception response.

# response-boxing-starter

#### 介绍
这是一个简单的将返回结果封装为统一格式的小工具，并且可以通过在配置文件中配置response.plugin.timestamp.enable=true就可以在返回结果中添加时间戳，并且可以设置你想要的时间戳格式。此外，你还可以通过继承DefaultAbstractException类来定义自己的异常类，继承该类使得本工具可以捕获它们，抛出异常时使用的也是正常返回时的统一格式。工具类本身提供了添加响应码/错误码的接口，可以在自定义异常类中使用。

#### 使用
1.引入依赖
```xml
<dependencies>
    <groupId>per.chao</groupId>
    <artifactId>response-boxing-starter</artifactId>
    <version>0.2.0-SNAPSHOT</version>
</dependencies>
```
> 私库地址
```xml
<snapshotRepository>
    <id>nexus-snapshots</id>
    <name>Nexus Maven Snapshot</name>
    <url>http://81.68.69.207:10000/repository/default_repository_snapshot/</url>
</snapshotRepository>
```
2.在启动类上开启
```java
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import pers.chao.boxing.EnableResponseBoxing;
@SpringBootApplication
@EnableResponseBoxing
public class Application {
    public static void main(String[] args){
       SpringApplication.run(Application.class, args);
    }
}
```
3.使用注解标注的@Controller+@ResponseBody或@RestController的类或方法
```java
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import pers.chao.boxing.core.ResponseNotBoxing;
@RestController
@ResponseBoxing
public class ExampleController {
    @RequestMapping("/hello")
    public String hello() {
        /**
         * response: {"code":200,"data":"hello","description":"success"}
         */
        return "hello";
    }
    
    // only return "hello2"
    @RequestMapping("hello2")
    @ResponseNotBoxing
    public String hello2() {
        return "hello2";
    }
}
```
4.自定义响应码 / 错误码
```java
// e.g.
public interface BusinessCode {
    StatusCode USERNAME_PASSWORD_ERROR = StatusCode.of(USERNAME_PASSWORD_ERROR_CODE, USERNAME_PASSWORD_ERROR_DESC);

int USERNAME_PASSWORD_ERROR_CODE = 10000;
    String USERNAME_PASSWORD_ERROR_DESC = "username or password error.";
}
```
5.自定义异常类
```java
import pers.chao.tool.exception.DefaultStatusCodeException;
public class CustomException extends DefaultStatusCodeException {
	private static final long serialVersionUID = 4751592988002609351L;
	public CustomException(StatusCode statusCode) {
		super(statusCode);
	}

public CustomException(StatusCode statusCode, String message) {
		super(statusCode, message);
	}

public CustomException(StatusCode statusCode, Throwable cause) {
		super(statusCode, cause);
	}

public CustomException(StatusCode statusCode, String format, Object... args) {
		super(statusCode, format, args);
	}
}
```
6.自定义状态码/错误码的使用
```java
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import pers.chao.boxing.core.ResponseBoxing;
@RestController
public class BusinessController {
    @ResponseBoxing
    @GetMapping("/exception")
    public String exception(){
        throw new CustomException(BusinessCode.USERNAME_PASSWORD_ERROR);
    }
}
```

阿超Bug便利店/response-boxing-starter

简介

发行版 (1)

贡献者

近期动态

阿超Bug便利店/response-boxing-starter .gitee-modal { width: 500px !important; }

简介

发行版 (1)

贡献者

近期动态

搜索帮助

阿超Bug便利店/response-boxing-starter