Chiship SDK

介绍

Текущая версия: 3.8.1

Chiship SDK — это небольшая и полная библиотека инструментов Java, которая использует статические методы для инкапсуляции связанных API, что снижает затраты на изучение и повышает эффективность работы.

Компоненты:

1. chiship-sdk-all — все пакеты зависимостей агрегации;
2. chiship-sdk-core — общие ресурсы Chiship;
3. chiship-sdk-framework — фреймворк;
4. chiship-sdk-cache — кэш;
5. chiship-sdk-third — сторонние компоненты;
6. chiship-sdk-pay — агрегация компонентов оплаты;
7. chiship-swagger-ui — вторичная инкапсуляция Swagger-UI.

Установка

1. Для использования любого компонента необходимо внедрить основной код пакета (chiship-sdk-core).
2. Если компонент использует конфигурацию в форме файла, то файл application.properties следует поместить в собственный проект и настроить параметры в соответствии с шаблоном.
3. Файл redis.properties используется вместе с основным пакетом RedisUtil.

Команды

mvn install -P release mvn clean deploy -P release

Свойства файла .properties

1. application.properties

   （1）. Настройки электронной почты

   EMAIL_CONFIG_HOST=#####                      SMTP-сервер для подключения
   EMAIL_CONFIG_TRANSPORT_PROTOCOL=#####        Протокол, который будет использоваться для соединения с session (smtp, pop3, imap, nntp)
   EMAIL_CONFIG_SMTP_AUTH=#####                 Ложно по умолчанию, если true, то будет предпринята попытка аутентификации пользователя с помощью команды AUTH
   EMAIL_CONFIG_SMTP_PORT=#####                 Порт SMTP-сервера, который будет использован, если connect не указывает порт, он будет использоваться по умолчанию 25
   EMAIL_CONFIG_IS_SSL=#####                    Ложно по умолчанию. Указывает, будет ли использоваться безопасный протокол
   EMAIL_CONFIG_SMTP_SSL_PORT=#####             Порт безопасного протокола
   EMAIL_CONFIG_SEND_ADDRESS=#####              Имя пользователя SMTP по умолчанию
   EMAIL_CONFIG_SEND_ADDRESS_PASSWORD=#####     Пароль пользователя SMTP по умолчанию (зашифрованный с помощью AES)

   （2）. Облачное хранилище

   # Облачное хранилище Alibaba
   chiship.third.oss.ali.accessKey=******
   chiship.third.oss.ali.accessSecret=******
   chiship.third.oss.ali.endPort=oss-cn-shanghai.aliyuncs.com
   chiship.third.oss.ali.buckName=chiship
   chiship.third.oss.ali.root=chiship
   # Облачное хранилище Baidu
   chiship.third.oss.baidu.accessKey=******
   chiship.third.oss.baidu.accessSecret=******
   chiship.third.oss.baidu.endPort=bj.bcebos.com
   chiship.third.oss.baidu.buckName=chiship
   chiship.third.oss.baidu.root=chiship
   # Облачное хранилище Tencent
   chiship.third.oss.tencent.accessKey=******
   chiship.third.oss.tencent.accessSecret=******
   chiship.third.oss.tencent.endPort=ap-beijing
   chiship.third.oss.tencent.buckName=chiship-1251388006
   chiship.third.oss.tencent.root=chiship

   （3）. Платёж

     # Уведомление хоста
     chiship.pay.domain.notify=http://lj.free.idcfengye.com/chiship/api/pay
     # Платёжная система Alipay
     chiship.pay.ali.app-id=*******
     # Открытый ключ Alipay
     chiship.pay.ali.public-key=*******
     # Закрытый ключ Alipay
     chiship.pay.ali.primary-key=*******
     # WeChat
     # Идентификатор торгового партнёра
     chiship.pay.wx.mch-id=*******
     # Ключ v3
     chiship.pay.wx.v3.key=*******
     # Номер сертификата, v3 платёж
     chiship.pay.wx.v3.serial-number=*******
     # Первичный ключ платёжного сертификата, v3 платёж
     chiship.pay.wx.v3.primary-key=*******
     # Идентификаторы приложения WeChat (мини-программа, публичный аккаунт, приложение)
     chiship.pay.wx.app-id=*******
     chiship.pay.wx.app-id2=*******
     chiship.pay.wx.app-id3=*******

     Путь уведомления формируется автоматически путём объединения пути уведомления хоста и различных асинхронных уведомлений.
     TRADE_TYPE — параметр, определяющий способ оплаты, получаемый через перечисление TradeTypeEnum.
   
     Асинхронное уведомление WeChat о платеже
     /wxV3/payNotify/{TRADE_TYPE}
     Уведомление об асинхронном возврате WeChat
     /wxV3/refundNotify
     Асинхронное уведомление Alipay о платеже
     /ali/payNotify/{TRADE_TYPE}

   （4）. Прочее

   # Облачный обмен сообщениями
   chiship.third.sms.ali.accessKey=******
   chiship.third.sms.ali.accessSecret=******
   
   # Baidu AI интеграция
   chiship.third.ai.baidu.appId=******
   chiship.third.ai.baidu.apiKey=******
   chiship.third.ai.baidu.secretKey=******
   
   # DingTalk интеграция
   # Client ID
   chiship.third.ding-talk.app-key=******
   # Client Secret
   chiship.third.ding-talk.app-secret=******
   # Корпоративный идентификатор
   chiship.third.ding-talk.corp-id=******
   # Идентификатор мини-приложения плагина
   chiship.third.ding-talk.mini-app-id=******
   # Идентификатор агента исходного корпоративного приложения
   chiship.third.ding-talk.agent-id=******
   
   # WeChat Public Account
   chiship.third.wx-pub.app-key=******
   chiship.third.wx-pub.app-secret=******
   
   # WeChat Mini Program
   chiship.third.wx-mini.app-key=******
   chiship.third.wx-mini.app-secret=******

2. Примеры кода

（1）. Облачное хранение

 1. Создание дескриптора, настройка по умолчанию или через DfsDTO, ALI, TENCENT, BAI_DU
 2. Вызов различных методов через дескриптор, например, upload
 FileStorageService fileStorageService = DfsFactory.getFileStorageService(DfsEnum.ALI);
 fileStorageService.upload(InputStream, fileName);

（2）. Платёж

 1. Создание дескриптора, настройка по умолчанию или через PayDTO, PAY_WX_V3, PAY_ZFB
 2. Вызов различных методов через дескриптор, например, doPay
 PaymentService paymentService = PayFactory.getPaymentService(PayEnum.PAY_WX_V3);

``` paymentService.doPay(PayParamsModel, TradeTypeEnum.QR_CODE);