# easy-return

**Repository Path**: zxy130359/easy-return

## Basic Information

- **Project Name**: easy-return
- **Description**: 通过注解@Result可以给API接口默认实现统一的JSON格式返回，而不用重复写同样的一个代码，减少冗余代码，让代码更简洁，也会对异常进行捕获，用同样的JSON返回失败信息
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2021-04-08
- **Last Updated**: 2025-11-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# easy-return

#### 介绍
通过注解@Result可以给API接口默认实现统一的JSON格式返回，而不用重复写同样的一个代码，减少冗余代码，让代码更简洁，也会对异常进行捕获，用同样的JSON返回失败信息

#### 软件架构
软件架构说明


#### 安装教程

1.  可以下载源码将包名下的文件夹复制到项目中，即可调用注解
2.  最简单的方式，对您的代码没有侵入性，可以导入[maven依赖](https://s01.oss.sonatype.org/#nexus-search;quick~com.houlangmark)进行无感使用。
3.  <dependency>
4.      <groupId>com.houlangmark</groupId>
5.      <artifactId>easy-return</artifactId>
6.      <version>1.0.0</version>
7.  </dependency>

#### 使用说明

1.  欢迎大家对代码的不合理或漏洞提出建议，交流至上
2.  可以在控制器的方法级别上使用，即只针对此方法，也可以在控制器的类名上使用，则表示此控制器下所有方法都适用
3.  这样控制器下的方法只需要关注返回的数据类型即可，没有返回类型方法用void修饰即可，返回的JSON数据data就为null
4.  在启动类上添加注解扫描包即可启用。例如：@ComponentScan(basePackages = {"com.yhtx.easy"})