以下例子基于Spring Boot
第一步：添加Maven依赖
直接添加以下maven依赖即可
<dependency>
</groupId>
</artifactId>
</version>
</dependency>
第二步：创建一个interface
就以高德地图API为栗子吧
;
;
;
{
/**
* 聪明的你一定看出来了@Get注解代表该方法专做GET请求
* 在url中的${0}代表引用第一个参数，${1}引用第二个参数
*/
)
);
}
第三步：扫描接口
在Spring Boot的配置类或者启动类上加上@ForestScan注解，并在basePackages属性里填上远程接口的所在的包名
@SpringBootApplication
@Configuration
)
{
{
);
}
}
第四步：调用接口
OK，我们可以愉快地调用接口了
// 注入接口实例
@Autowired
;
...
// 调用接口
);
);
发送JSON数据
/**
* 将对象参数解析为JSON字符串，并放在请求的Body进行传输
*/
)
);
/**
* 将Map类型参数解析为JSON字符串，并放在请求的Body进行传输
*/
)
);
/**
* 直接传入一个JSON字符串，并放在请求的Body进行传输
*/
)
);
发送XML数据
/**
* 将一个通过JAXB注解修饰过的类型对象解析为XML字符串
* 并放在请求的Body进行传输
*/
)
);
/**
* 直接传入一个XML字符串，并放在请求的Body进行传输
*/
)
);
文件上传
/**
* 用@DataFile注解修饰要上传的参数对象
* OnProgress参数为监听上传进度的回调函数
*/
)
);
可以用一个方法加Lambda同时解决文件上传和上传的进度监听
{
// 已上传百分比
// 是否上传完成
);
}
});
多文件批量上传
/**
* 上传Map包装的文件列表，其中 ${_key} 代表Map中每一次迭代中的键值
*/
)
);
/**
* 上传List包装的文件列表，其中 ${_index} 代表每次迭代List的循环计数（从零开始计）
*/
)
);
文件下载
下载文件也是同样的简单
/**
* 在方法上加上@DownloadFile注解
* dir属性表示文件下载到哪个目录
* OnProgress参数为监听上传进度的回调函数
* ${0}代表引用第一个参数
*/
)
)
);
调用下载接口以及监听下载进度的代码如下：
{
// 已下载百分比
// 是否下载完成
);
}
});
基本签名验证
)
)
);
OAuth 2.0
(
,
,
,
,
,
,
)
)
();
自定义注解
Forest允许您根据需要自行定义注解，不但让您可以简单优雅得解决各种需求，而且极大得扩展了Forest的能力。
定义一个注解
/**
* 用Forest自定义注解实现一个自定义的签名加密注解
* 凡用此接口修饰的方法或接口，其对应的所有请求都会执行自定义的签名加密过程
* 而自定义的签名加密过程，由这里的@MethodLifeCycle注解指定的生命周期类进行处理
* 可以将此注解用在接口类和方法上
*/
@Documented
/** 重点： @MethodLifeCycle注解指定该注解的生命周期类*/
)
@RequestAttributes
)
/** 指定该注解可用于类上或方法上 */
})
{
/**
* 自定义注解的属性：用户名
* 所有自定注解的属性可以在生命周期类中被获取到
*/
();
/**
* 自定义注解的属性：密码
* 所有自定注解的属性可以在生命周期类中被获取到
*/
();
}
定义注解生命周期类
/**
* MyAuthLifeCycle 为自定义的 @MyAuth 注解的生命周期类
* 因为 @MyAuth 是针对每个请求方法的，所以它实现自 MethodAnnotationLifeCycle 接口
* MethodAnnotationLifeCycle 接口带有泛型参数
* 第一个泛型参数是该生命周期类绑定的注解类型
* 第二个泛型参数为请求方法返回的数据类型，为了尽可能适应多的不同方法的返回类型，这里使用 Object
*/
{
/**
* 当方法调用时调用此方法，此时还没有执行请求发送
* 次方法可以获得请求对应的方法调用信息，以及动态传入的方法调用参数列表
*/
@Override
{
);
}
/**
* 发送请求前执行此方法，同拦截器中的一样
*/
@Override
{
// 通过getAttribute方法获取自定义注解中的属性值
// getAttribute第一个参数为request对象，第二个参数为自定义注解中的属性名
);
);
// 使用Base64进行加密
);
// 调用addHeader方法将加密结构加到请求头MyAuthorization中
);
;
}
/**
* 此方法在请求方法初始化的时候被调用
*/
@Override
{
);
}
}
使用自定义的注解
/**
* 在请求接口上加上自定义的 @MyAuth 注解
* 注解的参数可以是字符串模板，通过方法调用的时候动态传入
* 也可以是写死的字符串
*/
)
)
);