32 Star 127 Fork 26

程序猿的游戏历险记 / vinus-spring-boot-starter

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

针对阿里云组件封装的一个神奇starter: vinus-spring-boot-starter

TODO 新增了日志处理相关的,最近忙没时间写文档……后面更新

2019-12-09更新

  1. 添加人机验证模块(captcha),主要用于阿里云数据风控(业务安全)模块的后台pc端配置,详情请看:阿里云人机验证说明文档
  2. 版本号升级为0.4.1

介绍

针对阿里云的产品进行的spring boot starter的封装,目前只封装了afs(人机验证,captcha)、sms(短信验证)、oss(对象存储)、sts(访问控制)四个模块,后续有需求我会进一步的添加,对于我来说sms与oss两个模块目前用的最多。所以这块也做了一些封装

软件架构

版本需求

当前工程版本:0.4.1

jdk版本 maven版本 spring boot

aliyun-core aliyun-oss aliyun-sts

系统配置
  • 系统配置是按照“你需要什么就配置什么”的原则来进行相关配置,所以对于不同的模块就需要不同的配置:所以对于配置,目前分为四大块:captcha配置,oss配置,sms配置,sts配置
  • 所有配置基本上都会包含三个数据:1、accessKeyId 2、accessKey Secret 3、regionId(选填),以上的三个数据是每个可编程访问模块所必须的数据,这三项数据由阿里云的访问控制中创建子账号进行提供的,对于访问控制请看:访问控制
  • captchaafs配置主要包括:appKey应用秘钥、scene验证类型
  • oss配置主要包括:默认的bucket、endpoint、oss代理过期时间、bucket与域名绑定的映射4项
  • sms配置主要包括:endpoint、sms的产品类型(目前定死为Dysmsapi)、短信发送的域名(目前定死dysmsapi.aliyuncs.com)
  • sts配置主要包括:阿里云资源与角色对照信息、角色会话名称、临时授权的过期时间

安装教程

  1. 下载此工程,通过mvn intall后,引入其依赖:

		<dependency>
			<groupId>com.kuding</groupId>
			<artifactId>vinus-spring-boot-starter</artifactId>
			<version>0.4.1</version>
		</dependency>
		
  1. appplication.propertiesapplication.yml文件中进行相关配置

  2. 加入captcha人机验证模块,则需要做如下配置:


vinus.enable-aliyun-captcha=true
aliyun.captcha.access-key-id=你自己的accessId
aliyun.captcha.secret=你自己的access-secret
aliyun.captcha.region-id=cn-hangzhou
aliyun.captcha.app-key=你自己的appKey
aliyun.captcha.sene=登录验证方式方式

  1. 加入需要引入短信模块,则需要做如下配置:

vinus.enable-aliyun-sms=true
aliyun.sms.access-key-id=你自己的accessId
aliyun.sms.secret=你自己的access-secret
aliyun.sms.region-id=cn-hangzhou
  1. 若需要引入oss模块,则需要引入如下配置:
vinus.enable-aliyun-oss=true
aliyun.oss.access-key-id=你自己的accessId
aliyun.oss.secret=你自己的access-secret
aliyun.oss.default-bucket=my-bucket
aliyun.oss.policy-timeout=30m
aliyun.oss.end-point=oss-cn-xxx.aliyuncs.com
  1. sts模块暂时先不讲了,有机会再说

使用说明

对于应用也非常的简单,核心的类为XxxComonent。阿里云的afs(captcha)的核心类为AliCaptchaComponent、阿里云sms的核心类为SmsComponent、阿里云oss的核心类为OssComponent、阿里云Sts核心类为StsComponent;

  • 对于captcha(afs)组件,核心方法为public boolean check(HttpServletRequest httpServletRequest, CaptchaContent capcha)方法,通过httpservletrequest来进行处理请求的相关信息,CaptchaContent是用于验证的一些关键参数,目前只支持pcweb端的验证。对于人机验证的相关的文档请参看:https://help.aliyun.com/product/28308.html

  • 对于sms组件,核心的方法为public void doSendSms(String phone, String smsSignature, String templateCode, Map<String, String> map)方法,参数依次为:手机号、短信签名、短信模板code、和参数(map结构);对于短信签名一般都是固定的,对于templateCode的管理建议可以通过enum的方式进行管理

public enum SmsTemplate {

	MODIFY_PWD("SMS_120270002"), CREATE_USER("SMS_172223677"), RESET_PWD("SMS_162524221"), INIT_SAAS("SMS_162546827");;

	private final String template;

	public String getTemplate() {
		return template;
	}

	private SmsTemplate(String template) {
		this.template = template;
	}

}
  • ossComponent对于我而言是最常用的组件,所以对于oss的封装也是最全面的。对于大部分情况而言,oss上传需要web端进行直传,所以需要服务端进行获取一个临时授权策略给web端,web端可以通过授权策略记性web端直传,具体流程可以查看阿里云官方文档:https://help.aliyun.com/document_detail/112718.html 临时授权策略需要的信息已封装到类中:OssPolicy,用法也很简单:
	@PostMapping("/createExplainPicPolicy")
	@ApiOperation("创建一个说明图片上传的临时策略")
	public ResultModel<OssPolicy> createExplainPicPolicy() {
		OssPolicy ossPolicy = ossComponent.createOssPolicy("文件目录", "my-bucket");
		return ResponseStatusEnum.SUCCESS.createResultModel(ossPolicy);
	}

第一个参数表示是哪个文件目录,第二个参数表示是哪个bucket

  • 当然对于oss,有一些情况是需要服务端进行上传信息的,这一部分非常的灵活,oss不仅可以上传文件,还可以上传任何形式的文本(json、xml、html等)假如你上传的是json,通过oss获取也是标准的restful风格的接口的话,支付要在Oss配置需要的header(例如content-type)即可,如:
	/**
	 * 将一个字符串上传到oss
	 * 
	 * @param object
	 * @param contentType
	 * @param path
	 * @return
	 */
	public String putStringToOss(String object, ContentType contentType, String path) 

说在后面

  • 这个框架也比较简单,思想上主要是把阿里云的组件进行模块化开发,这样的好处就是方便与其他的框架(spring cloud)整合并方便配合阿里云控制台进行管理。我在这也算是抛砖引玉,对于有阿里云其他模块开发的需求,可以留言给我,我看看如何进行添加。
  • 最近比较忙,此框架的文档我也会不定期的进行完善。

Fork me on Gitee

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

针对阿里云的产品进行的spring boot starter 的封装,目前只封装了captcha、sms、oss、sts三个模块 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/ITEater/vinus-spring-boot-starter.git
git@gitee.com:ITEater/vinus-spring-boot-starter.git
ITEater
vinus-spring-boot-starter
vinus-spring-boot-starter
master

搜索帮助