# obp-soa

**Repository Path**: jackey-room/obp-soa

## Basic Information

- **Project Name**: obp-soa
- **Description**: obp-soa 项目组件
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 3
- **Created**: 2024-11-07
- **Last Updated**: 2025-04-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 使用方式介绍

| 名称        | 介绍           |
|-----------|--------------|
| obp-auth  | 登录相关功能       |
| obp-core  | SpringBoot基础 |
| obp-data  | MySql和Redis  |
| obp-email | 邮件发送功能       |
| obp-log   | 阿里云SLS相关     |
| obp-ons   | 阿里云ONS相关     |
| obp-oss   | 阿里云OSS相关     |
| obp-pay   | 支付功能相关       |
| obp-sms   | 短信发送功能       |
| obp-upms  | RBAC权限控制     |

## obp-auth

```xml
        <dependency>
            <groupId>org.obp</groupId>
            <artifactId>obp-auth</artifactId>
            <version>${obp-auth.version}</version>
        </dependency>
```
配置文件使用:
```yml
sa-token:
  token-name: ${obp.upms.token-name}
  timeout: ${obp.upms.token-timeout}
  activity-timeout: -1
  is-concurrent: true
  is-share: false
  token-style: tik
  is-log: false
```

## obp-core

```xml
        <dependency>
            <groupId>org.obp</groupId>
            <artifactId>obp-core</artifactId>
            <version>${obp-core.version}</version>
        </dependency>
```

## obp-data

```xml
        <dependency>
            <groupId>org.obp</groupId>
            <artifactId>obp-data</artifactId>
            <version>${obp-data.version}</version>
        </dependency>
```
配置文件使用:
```yml
spring:
  redis:
    host: ${obp.redis.host}
    port: ${obp.redis.port}
    password: ${obp.redis.password}
    database: ${obp.redis.database}
    timeout: 10s
    lettuce:
      pool:
        max-active: 200
        max-wait: 3000
        max-idle: 10
        min-idle: 0

  datasource:
    dynamic:
      primary: master
      strict: false
      datasource:
        master:
          driver-class-name: ${obp.datasource.driver-class-name}
          url: ${obp.datasource.url}
          username: ${obp.datasource.username}
          password: ${obp.datasource.password}
          druid:
            initial-size: 1
            min-idle: 5
            max-active: 30
            max-wait: 60000
            time-between-eviction-runs-millis: 60000
            min-evictable-idle-time-millis: 300000
            validation-query: SELECT 1
            test-while-idle: true
            test-on-borrow: false
            test-on-return: false
            pool-prepared-statements: true
            max-pool-prepared-statement-per-connection-size: 50

mybatis-plus:
  mapper-locations: classpath*:mybatis/*/*.xml
  global-config:
    db-config:
      logic-delete-field: deleteFlag
      logic-delete-value: 1
      logic-not-delete-value: 0
```

## obp-email

```xml
        <dependency>
            <groupId>org.obp</groupId>
            <artifactId>obp-email</artifactId>
            <version>${obp-email.version}</version>
        </dependency>
```
配置文件使用:
```yml
spring:
  mail:
    enable: true
    host: smtp.gmail.com
    username: ${obp.email.username}
    password: ${obp.email.password}
    default-encoding: UTF-8
    properties:
      mail.smtp.auth: true
      mail.smtp.port: 465
      mail.smtp.starttls.enable: true
      mail.smtp.starttls.required: true
      mail.smtp.ssl.enable: true
```

## obp-log

```xml
        <dependency>
            <groupId>org.obp</groupId>
            <artifactId>obp-log</artifactId>
            <version>${obp-log.version}</version>
        </dependency>
```
配置文件使用:
```yml
logging:
  config: classpath:logstore/logback-aliyun.xml
```
logback-aliyun.xml
```xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!--为了防止进程退出时，内存中的数据丢失，请加上此选项-->
    <shutdownHook class="ch.qos.logback.core.hook.DelayingShutdownHook"/>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger - %msg %X{THREAD_ID} %n</pattern>
        </encoder>
    </appender>

    <appender name="service-log" class="com.aliyun.openservices.log.logback.LoghubAppender">

        <!--必选项-->
        <!-- 账号及网络配置 -->
        <endpoint>${obp.sls.endpoint}</endpoint>
        <accessKeyId>${obp.sls.accessKeyId}</accessKeyId>
        <accessKeySecret>${obp.sls.accessKeySecret}</accessKeySecret>

        <!-- sls 项目配置 -->
        <project>${obp.sls.project}</project>
        <logStore>${obp.sls.logStore}</logStore>
        <!--必选项 (end)-->

        <!-- 可选项 详见 '参数说明'-->
        <totalSizeInBytes>104857600</totalSizeInBytes>
        <maxBlockMs>0</maxBlockMs>
        <ioThreadCount>8</ioThreadCount>
        <batchSizeThresholdInBytes>524288</batchSizeThresholdInBytes>
        <batchCountThreshold>4096</batchCountThreshold>
        <lingerMs>2000</lingerMs>
        <retries>10</retries>
        <baseRetryBackoffMs>100</baseRetryBackoffMs>
        <maxRetryBackoffMs>50000</maxRetryBackoffMs>

        <!--只打印级别含INFO及以上的日志-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>

        <!-- 可选项 设置时间格式 -->
        <timeZone>Asia/Shanghai</timeZone>
        <timeFormat>yyyy-MM-dd HH:mm:ss</timeFormat>
        <mdcFields>traceID</mdcFields>
    </appender>

    <appender name="request-log" class="com.aliyun.openservices.log.logback.LoghubAppender">

        <!--必选项-->
        <!-- 账号及网络配置 -->
        <endpoint>${obp.sls.endpoint}</endpoint>
        <accessKeyId>${obp.sls.accessKeyId}</accessKeyId>
        <accessKeySecret>${obp.sls.accessKeySecret}</accessKeySecret>

        <!-- sls 项目配置 -->
        <project>${obp.sls.project}</project>
        <logStore>${obp.sls.logStore}</logStore>
        <!--必选项 (end)-->

        <!-- 可选项 详见 '参数说明'-->
        <totalSizeInBytes>104857600</totalSizeInBytes>
        <maxBlockMs>0</maxBlockMs>
        <ioThreadCount>8</ioThreadCount>
        <batchSizeThresholdInBytes>524288</batchSizeThresholdInBytes>
        <batchCountThreshold>4096</batchCountThreshold>
        <lingerMs>2000</lingerMs>
        <retries>10</retries>
        <baseRetryBackoffMs>100</baseRetryBackoffMs>
        <maxRetryBackoffMs>50000</maxRetryBackoffMs>

        <!--只打印级别含INFO及以上的日志-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>

        <!-- 可选项 设置时间格式 -->
        <timeZone>Asia/Shanghai</timeZone>
        <timeFormat>yyyy-MM-dd HH:mm:ss</timeFormat>
        <mdcFields>traceID</mdcFields>
    </appender>

    <root>
        <level value="INFO"/>
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="service-log"/>
    </root>

    <logger name="org.obp.log.aspect.WebLogAspect" level="INFO" additivity="false">
        <appender-ref ref="request-log"/>
    </logger>

</configuration>
```
## obp-ons

```xml
        <dependency>
            <groupId>org.obp</groupId>
            <artifactId>obp-ons</artifactId>
            <version>${obp-ons.version}</version>
        </dependency>
```
配置文件使用:
```yml
ons:
  rocketmq:
    enable: ture
    accessKey: ${obp.rocketmq.accessKey}
    secretKey: ${obp.rocketmq.secretKey}
    nameSrvAddr: ${obp.rocketmq.nameSrvAddr}
    groupId: ${obp.rocketmq.groupId}
    topic: ${obp.rocketmq.topic}
    topic_timing: ${obp.rocketmq.topic_timing}
    topic_transaction: ${obp.rocketmq.topic_transaction}
```

## obp-oss

```xml
        <dependency>
            <groupId>org.obp</groupId>
            <artifactId>obp-oss</artifactId>
            <version>${obp-oss.version}</version>
        </dependency>
```
配置文件使用:
```yml
oss:
  aliyun:
    buckName: ${obp.oss.buckName}
    endPoint: ${obp.oss.endPoint}
    cdnHost: ${obp.oss.cdnHost}
    accessKeyId: ${obp.oss.accessKeyId}
    accessKeySecret: ${obp.oss.accessKeySecret}
    policy.expireSecond: ${obp.oss.policy.expireSecond}
```
RocketMQ生产者使用:
```java
public final class MqMessageProducer {
    
}
```
RocketMQ消费者继承实现:
```java
public abstract class AbsMqMessageConsumer implements MessageListener {
    
    public abstract MqBizTags support();

}
```

## obp-pay

```xml
        <dependency>
            <groupId>org.obp</groupId>
            <artifactId>obp-pay</artifactId>
            <version>${obp-pay.version}</version>
        </dependency>
```
配置文件使用:
```yml
pay:
  wechat:
    appId_ma: ${obp.pay.wechat.appId_ma}
    appId_app: ${obp.pay.wechat.appId_app}
    merchantId: ${obp.pay.wechat.merchantId}
    privateKey: ${obp.pay.wechat.privateKey}
    merchantSerialNumber: ${obp.pay.wechat.merchantSerialNumber}
    apiV3Key: ${obp.pay.wechat.apiV3Key}
    domain: ${obp.pay.wechat.domain}
    payNotifyUrl: ${obp.pay.wechat.payNotifyUrl}
    refundNotifyUrl: ${obp.pay.wechat.refundNotifyUrl}
    expiredMinutes: ${obp.pay.wechat.expiredMinutes}
```
强制实现回调服务:
```java
public interface PaymentCallbackService {

}
```

## obp-sms

```xml
        <dependency>
            <groupId>org.obp</groupId>
            <artifactId>obp-sms</artifactId>
            <version>${obp-sms.version}</version>
        </dependency>
```
配置文件使用:
```yml
sms:
  credential: ${obp.credential}

  aliyun:
    enable: false
    regionId: ${obp.sms.regionId}
    accessKeyId: ${obp.sms.accessKeyId}
    accessKeySecret: ${obp.sms.accessKeySecret}
    signName: ${obp.sms.signName}

  fortdigital:
    enable: false
    gateway: ${obp.sms.intl.gateway}
    username: ${obp.sms.intl.username}
    password: ${obp.sms.intl.password}
    signName: ${obp.sms.intl.signName}
```

## obp-upms

```xml
        <dependency>
            <groupId>org.obp</groupId>
            <artifactId>obp-upms</artifactId>
            <version>${obp-upms.version}</version>
        </dependency>
```
配置文件使用:
```yml
upms:
  initResourceMeta: true
  securityWhiteList: /favicon.ico,/v1/work/auth/**
  
sa-token:
  token-name: ${obp.upms.token-name}
  timeout: ${obp.upms.token-timeout}
  activity-timeout: -1
  is-concurrent: true
  is-share: false
  token-style: tik
  is-log: false
```