# Aiwan

**Repository Path**: ctoisme_admin/Aiwan

## Basic Information

- **Project Name**: Aiwan
- **Description**: 这是一个基于spring技术栈的微服务脚手架
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2020-01-15
- **Last Updated**: 2022-04-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# AIWAN | 爱玩商城
本项目是一个开源项目，参考此项目你可以快速开启一个微服务项目的框架搭建，亦可以在这里找到一些技术的最佳实践，为你的项目开发提供参考。
如果你觉得此项目有价值，请给我点个star，谢谢！
> 项目地址：https://github.com/bestaone/Aiwan

如果你需要一个开箱即用、一个微服务集成方案，请移步这个项目HiAuth
> 地址 ： https://github.com/bestaone/HiAuth

## 功能介绍
- 这个脚手架可以帮助你快速启动一个基于spring技术栈的微服务项目开发
- 包含一个基于spring-cloud-starter-oauth2的oauth2认证服务
- 认证服务器支持了图形验证码、短信验证码功能
- 包含了三个微服务的演示模块user、goods、order，需要通过oauth2认证后才能访问
- 包含一个web demo web-mall，演示如何通过oauth2认证后访问各个微服务
- 演示web服务通过oauth2认证后，调用微服务接口获取数据的完整流程
- 演示了如何通过starter扩展功能(oauth2、swagger2、monitor)
- 演示了如何统一控制接口规范
- 演示了如何规范异常处理
- 演示了如何规范使用mybaits、分页
- 演示了单元测试、mock测试、测试数据回滚，包括对controller、service的测试
- 演示了swagger2集成oauth2服务
- 不打算集成spring cloud，个人比较喜欢service mesh，后面会集成Kubernetes、Istio

## 目录结构
```
├─aiwan                         项目根，在此目录下可以构建全部模块
├─aiwan-common                  公共代码
├─aiwan-core                    微服务核心包，只有微服务依赖此包
├─aiwan-microsvr-api            服务接口包
├─aiwan-microsvr-goods          goods微服务
├─aiwan-microsvr-order          order微服务
├─aiwan-microsvr-user           user微服务
├─aiwan-starter-monitor         监控starter
├─aiwan-starter-oauth2          oauth2客户端starter
├─aiwan-starter-swagger2        swagger2 starter
├─aiwan-web-auth                认证模块
├─aiwan-web-mall                购物中心模块
└─doc                           文档目录
```

## 目录介绍
- aiwan-common : 公共模块，提供比较通用的功能，比如：最基本的异常基类、接口基类、工具类等
- aiwan-core ： 微服务模块的核心包，提供一些核心的、通用的系统控制。例如：Service、Mapper的统一控制、通用拦截等
- aiwan-starter-monitor ： 监控功能的starter项目
- aiwan-starter-oauth2 ： oauth2 client功能的starter项目
- aiwan-starter-swagger2 ： swagger2功能的starter项目
- aiwan-microsvr-api ： 微服务业务接口定义，将所有接口打成jar，便于在client中使用
- aiwan-microsvr-user ： user微服务，包含用户业务接口
- aiwan-microsvr-goods ： goods微服务，包含商品业务接口
- aiwan-microsvr-order ： order微服务，包含订单业务接口 [ [文档](https://github.com/bestaone/Aiwan/blob/master/aiwan-microsvr-order/README.md)：介绍如何开发服务接口 ]
- aiwan-web-auth ： 基于Oauth2的授权服务 [ [文档](https://github.com/bestaone/Aiwan/blob/master/aiwan-web-auth/README.md)：介绍如何开发认证服务 ]
- aiwan-web-mall ： mall演示项目 [ [文档](https://github.com/bestaone/Aiwan/blob/master/aiwan-web-mall/README.md)：介绍如何集成认证服务 ]


## 快速启动

### 创建数据库
- 数据使用的是mysql5.6
- 创建数据库user，运行脚本 aiwan-microsvr-user/doc/user.sql
- 创建数据库goods，运行脚本 aiwan-microsvr-goods/doc/goods.sql
- 创建数据库order，运行脚本 aiwan-microsvr-order/doc/order.sql
- 默认数据库配置如下，如果不正确请修改配置文件 resources/application.properties
```
spring.datasource.url = jdbc:mysql://127.0.0.1:3306/[user|goods|order]
spring.datasource.username = root
spring.datasource.password = 123456
```

### 构建、测试
- 执行如下命名会编译、测试
```
cd aiwan
mvn clean install
```

### 启动
- 这个项目包含5个可运行项目，项目名及端口为auth:8080、mall:8081、user:9080、goods:9081、order:9082
- 启动这5个项目，启动不分先后顺序
```
cd aiwan-web-auth
mvn spring-boot:run

cd aiwan-web-mall
mvn spring-boot:run

cd aiwan-microsvr-user
mvn spring-boot:run

cd aiwan-microsvr-goods
mvn spring-boot:run

cd aiwan-microsvr-order
mvn spring-boot:run
```

### 验证

#### mall验证
- 访问mall主页 http://localhost:8081/mall, 点击signin登录
- 被重定向到了auth服务进行认证，输入账号登录
- 被重定向回mall系统，进入mall首页，登录成功

#### auth验证
- 访问auth主页 http://localhost:8080/auth
- 输入账号登录
- 进入首页

#### swagger2验证
- 访问user项目swagger2 ui地址 http://localhost:9080/user/swagger-ui.html
- 直接测试接口，显示未认证
- 点击认证按钮，会被重定向到auth进行认证，输入账号登录
- 被重定向到user的swagger2页面
- 再次测试接口，获取正确数据

#### oath2授权验证

##### authorization_code 认证流程
参看 [mall验证]
> 注意：如果授权环节不出现，可以清除下数据库的数据（clientdetails、oauth_access_token、oauth_approvals、oauth_client_token、oauth_code、oauth_refresh_token）

##### password 认证流程
- 使用POST访问获取access_token接口(password模式)
> http://localhost:8080/auth/oauth/token?username=user&password=123456&grant_type=password&client_id=client&client_secret=123456

- 正常访问后返回 json 格式的 token
```
{
    "access_token": "7d2dba1c-506f-4d27-ad61-99aed4f5ba01",
    "token_type": "bearer",
    "refresh_token": "ff321a00-292e-4754-9832-52366a725cff",
    "expires_in": 1799,
    "scope": "ALL AUTH USER GOODS ORDER"
}
```

- 使用GET访问 [http://localhost:9082/order/api/order/1]，返回401，未授权
```
{
    "error": "unauthorized",
    "error_description": "Full authentication is required to access this resource"
}
```

- 使用GET访问 [http://localhost:9082/order/api/order/1]，在请求头添加凭证 Authorization Bearer {access_token},能获取到数据
```
{
    "code": 10000,
    "data": {
        "id": 1,
        "no": "20190101123010001",
        "title": "Iphone X (深空灰色，256G) 1台",
        "totalAmount": 10000,
        "createTime": 1548496807000,
        "status": "PAID"
    }
}
```

- 无权限拦截的测试 [http://localhost:8081/mall/test/a] （未实现）

##### client_credentials 认证流程
- 使用POST访问获取access_token接口(client_credentials模式)
> http://localhost:8080/auth/oauth/token?grant_type=client_credentials&client_id=client&client_secret=123456&scope=ORDER

- 正常访问后返回 json token
```
{
    "access_token": "aafe4fa8-0403-4bc4-8da3-cb21bdca247c",
    "token_type": "bearer",
    "expires_in": 1799,
    "scope": "ORDER"
}
```

- 使用GET访问 [http://localhost:9082/order/api/order/1]，返回401，未授权
```
{
    "error": "unauthorized",
    "error_description": "Full authentication is required to access this resource"
}
```

- 使用GET访问 [http://localhost:9082/order/api/order/1]，在请求头添加凭证 Authorization Bearer {access_token},能获取到数据
```
{
    "code": 10000,
    "data": {
        "id": 1,
        "no": "20190101123010001",
        "title": "Iphone X (深空灰色，256G) 1台",
        "totalAmount": 10000,
        "createTime": 1548496807000,
        "status": "PAID"
    }
}
```
- 无权限拦截的测试 [http://localhost:8081/mall/test/a] （未实现）

##### scop权限范围验证
- 使用POST访问获取access_token接口,并且设置scope=USER(password模式)
> http://localhost:8080/auth/oauth/token?username=user&password=123456&grant_type=password&client_id=client&client_secret=123456&scope=USER

- 返回的 json token 的权限范围是 USER
```
{
    "access_token": "c53314b6-acae-4bea-8f5e-81a61870edee",
    "token_type": "bearer",
    "refresh_token": "f24af724-ea3e-40d2-af64-577137530eda",
    "expires_in": 1799,
    "scope": "USER"
}
```

- 使用GET访问 [http://localhost:9082/order/api/order/1]，在请求头添加凭证 Authorization Bearer {access_token}，被拒绝（这个接口设置了需要ORDER权限）
```
{
    "error": "insufficient_scope",
    "error_description": "Insufficient scope for this resource",
    "scope": "ALL ORDER"
}
```

> 所有的localhost不能使用127.0.0.1代替，因为auth会检查域名的合法性，数据库中登记的是localhost

> 请使用火狐浏览器测试，在Chrome上生成验证码有个bug，暂时没处理

## 贴图

### mall演示认证流程（接口路径、页面、scope等经过了多次调整，可能不一致，动图仅供参考）
![image](https://raw.githubusercontent.com/bestaone/Aiwan/master/doc/mall.gif)

### oauth2认证流程（接口路径、页面、scope等经过了多次调整，可能不一致，动图仅供参考）
![image](https://raw.githubusercontent.com/bestaone/Aiwan/master/doc/oauth2.gif)
 
## 前端
上面介绍了，项目的后端功能，以及简单的、嵌入在jar内部的模板页面。这里也提供了前后端分离的demo
> 前端：https://github.com/bestaone/AiwanFront

## 未完事项
- 将认证服务和资源服务合并在一起的时候，验证authorization_code功能时，登录时报错“不支持 POST”,初步定为是 auth server 的SecurityConfig的HttpSecurity http未设置好
- 做一个用户管理中心前端，有兴趣的移步[ [用户管理中心](https://github.com/bestaone/AiwanFront/)]
- 加入redis缓存，解决验证码在Chrome中的bug
- 支持微信登录、qq登录
- 整合docker
- 整合Kubernetes
- 整合Istio