# jBeacon

**Repository Path**: RiceZhang/jBeacon

## Basic Information

- **Project Name**: jBeacon
- **Description**: jBeacon is java project . In this project , I will try write some code I usually using in my job, of course , I willing share it with everyone.
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 1
- **Created**: 2016-06-15
- **Last Updated**: 2026-01-07

## Categories & Tags

**Categories**: security-dev

**Tags**: None

## README

jBeacon项目简介 
===============

### 项目景愿
>
尝试一些小，精，巧，优，可维护，性能也不错的东西，如不错的记录文章，小巧的代码等。


### 项目面向对象
> 
如果你对本项目/组织 有好的idea 欢迎留言，当然本项目/组织对每个想参与的人都是开放的。issues, start，pull_requests,已及贡献你优秀的项目到本组织，都是可以实践的方式。


### 参与规范
> 
- 面对你提的issues 我们都会尽量回复，我们都是有工作的人，回复会相当滞后，希望你能耐心等候，并谅解。
- 面对pull_requests，请把你的实施想法尽量清晰的描述出来。
- 面对pull_requests 审核者 起码能有2人过审，以期望达到优质标准。

### 相关术语
1. oauth2.0
2. Bearer 标准
3. C端：to Customer，对接客户; B 端，to Bussiness, 对接商户; O 端，to Operator，对接运维/运营  


### 架构说明

![架构图](./doc/jbeacon_v1.0.0.png "架构图")

图列说明

| 序号 | 操作                                               | 备注                |
| -----| ---------------------------------------------------| ------------------- |
| 1    | app-x 向auth申请授权                               |oauth/token          |
| 2    | auth返回授权token                                  |                     |
| 3    | app-x 访问jbeacon-api-x                            |                     |
| 4    | jbeacon-api-x 用RemoteTokeService向auth 验证token  |                     |
| 5    | auth 向jbeacon-api-x 反馈验证结果                  |                     |
| 6    | jbeacon-api-x 允许访问                             |                     |



规划
-

## 组件
|  模块                                           | 语言   | 优先级    | 状态     | 执行人    |    备注    |
|  ----------------------------------------------|-------| -------- |-------- |--------  |-----------|
|  jbeacon-spring-boot-starter-starter           | JAVA  |          | FINISH  |  ZRX     |           |
|  jbeacon-spring-boot-starter-mybatis           | JAVA  |          | FINISH  |  ZRX     |           |
|  jbeacon-spring-boot-starter-logging           | JAVA  |          | FINISH  |  ZRX     |           |
|  jbeacon-spring-boot-starter-test              | JAVA  |          | FINISH  |  ZRX     |           |
|  jbeacon-spring-boot-starter-config-apollo     | JAVA  |          | FINISH  |  ZRX     |           |
|  jbeacon-spring-boot-starter-job-saturn        | JAVA  |          |         |          |           |
|  jbeacon-spring-boot-starter-mq-rabbite        | JAVA  |          |         |          |           |
|                                                |       |          |         |          |           |


## 应用服务
|  模块                                      | 语言   | 优先级    | 状态    | 执行人     |    备注        |
|  -----------------------------------------|-------| -------- |-------- |----------|---------------|
|  pay-parent                               | JAVA  |          | FINISH  |  ZRX     | 聚合支付模块    |
|  shop-parent                              | JAVA  |          | FINISH  |  ZRX     | 商户租户模块    |
|  user-parent                              | JAVA  |          | FINISH  |  ZRX     | 用户模块       |
|                                           |       |          |         |          |               |


## 客户端
|  模块                                      | 语言     | 优先级    | 状态    | 执行人     |     备注         |
|  -----------------------------------------|---------| -------- |-------- |----------|-----------------|
|          app                                 | Kotlin  |          |         |          | 移动端(安卓 IOS)  |
|                                           |         |          |         |          |                 |


### DB相关

| 序号 | 文件         | 备注       |
| -----| -------------| ---------- |
| 1    | jbeacon-DML  |无          |
| 2    | jbeacon-DDL  |无          |
| 3    |              |            |


### 配置相关
| 序号 | 项目         | 变更类型（新增/修改）|变更key       |变更value  |
| -----| -------------| -------------------- | -------------|-----------|
| 1    |              |                      |              |           |
| 2    |              |                      |              |           |


### Oauth服务如何支持
>oauth 服务如何提供统一的支持，你可能需要这样做。

1. 向授权服务申请您的ClientId, 和 ClientSecret，请小心保管 ClientSecret，不要暴露到外在。 
目前默认策略：
C端：clientId: APP_CUSTOMER,  clientSecret：654321;
B端：clientId: APP_BUSSINESS, clientSecret：654321;
O端：clientId: APP_OPERATOR,  clientSecret：654321;


2. yml 配置



3. 依赖



4. 示例



### 实施说明
- 1. 启动jbeacon-mod-register 
你可以考虑在jbeacon-mod-register builder目录下执行./run.sh 这是个很好的方法。 
- 2. 可以考虑启动你喜欢的一个服务做任何调试，目前已经做了断融，不会有任何的影响，你可以开始愉悦的尝试之旅。



###  主要功能
1. 实现api调用跟踪链。
2. 实现授权服务，多端策略授权。


###  技术选型
- jdk >= 1.8.0
- spring-security
- oauth2.0 

### 未来版本规划
feature/1.0.0 

### 交流与反馈
欢迎您通过Issues来提交问题、报告与建议。


### 版权和许可证
由Apache-2.0 license提供。