# parrot-back

**Repository Path**: fd1184/parrot-back

## Basic Information

- **Project Name**: parrot-back
- **Description**: 模板工程后端
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-01
- **Last Updated**: 2022-05-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 欢迎使用 Parrot-Server
------
Parrot-Server 热果平台快速开发的后端模板工程（基于 SpringBoot ）

### [项目说明]

> 热果平台的PC端后端模板工程，Java语言版本，整合用户令牌签发校验、电商云API接口调用、租户用户管理、角色权限管理等功能。

------

## 内容

 * 目录结构
 * 开始使用
 * 用户认证
 * 开放平台接入

## 目录结构

    |--src
        |--main
            |--java
                |--com/gogbuy/parrot
                    |--common                   #通用模型
                    |--config                   #配置类
                    |--controller               #接口
                    |--dto                      #数据对象
                    |--exception                #异常类
                    |--util                     #工具类
            |--resources                        #配置文件
    |--pom.xml


## 开始使用
    1、下载该工程代码后，可导入任意IDE开发工具。
    2、找到/resources路径下的配置文件，依据运行环境配置环境变量。
    3、自行配置NoSQL服务、数据库服务。
    4、在/com/gogbuy/parrot下编写业务代码。

## 用户认证
    工程中引用sso-client的jar包，对接热果平台用户认证，实现用户登录后令牌的签发与校验，获取用户基本信息等功能。
jar包的引用有两种方式：
1、maven引用,其中sso-client的最新版本为 2.2.31
```java
        <dependency>
            <groupId>com.gogbuy.congo</groupId>
            <artifactId>sso-client</artifactId>
            <version>${sso-client.version}</version>
        </dependency>
```
2、从开放平台下载通用sso-client的jar包后自行引入工程。

引入sso-client的jar包，在对应环境的yml配置文件中配置如下sso相关配置：
```java
#权限配置
sso:
#  配置应用的appKey
  appKey: dsy_0pybpc2ivxmg
#  配置应用的密钥,由开放平台发放
  secretKey: vLNQFMAxEjy0eYLudHuR
#  sso服务端地址,不同环境配置对应的sso服务端地址
  ssoServerUrl: http://xxxxxxx
#  应用客户端部署地址
  ssoClientServer: http://xxxxxxxx
#  忽略拦截的url地址，逗号隔开，可选配置
  excluded:
    - /swagger-resources
    - /v2/**
    - /webjars/**
    - /doc.html
    - /wx/jscode2session
  excludedStatic:
    - .js
    - .css
    - .png
```

sso服务端地址：https://auth.gcongo.onebuygz.com

sso-client的jar包中，针对用户会话的缓存支持JVM和Redis两种方式，默认采用JVM缓存，同时支持基于SPI机制的功能拓展以实现自定义功能。

关于sso-client的SPI拓展，请在 [钉钉热果群] 里查阅相关文档或查阅[sso-client](http://10.10.11.151:10080/product/bigdata-cloudplatform/unified-user-login/sso-client-sc)文档。


## 开放平台接入
应用开发者应先在开放平台注册开发者账号，依据平台指南创建应用及发布不同渠道的应用端，具体请参考[开放平台指南](https://obs-2a0b-b2c.obs.cn-south-1.myhuaweicloud.com/doc/%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0%E6%8E%A5%E5%85%A5%E6%96%87%E6%A1%A3V1.1.docx)。

## 常见错误及解决办法

------
感谢您花费时间阅读这份文档，如有疑问请联系 【聚合平台】 项目组