feijie
1 year ago
10 changed files with 483 additions and 26 deletions
@ -0,0 +1,50 @@ |
|||
# 基于ABP CLI的扩展工具集 |
|||
|
|||
提供快速创建模板项目、生成JavaScript库命令等更多功能。 |
|||
|
|||
## 开始使用 |
|||
|
|||
```shell |
|||
dotnet tool install --global LINGYUN.Abp.Cli |
|||
``` |
|||
|
|||
## 使用方法 |
|||
|
|||
```shell |
|||
使用方法: |
|||
|
|||
labp <command> <target> [options] |
|||
|
|||
命令列表: |
|||
|
|||
> help: 显示命令行帮助。使用 ` labp help <command> ` 获取详细帮助 |
|||
> create: 基于自定义的ABP启动模板生成新的解决方案 |
|||
> generate-proxy: 生成客户端服务代理和DTO以消费HTTP API |
|||
> generate-view: 从HTTP API代理生成视图代码 |
|||
|
|||
获取命令的详细帮助: |
|||
|
|||
labp help <command> |
|||
``` |
|||
|
|||
## 功能特性 |
|||
|
|||
* 支持生成TypeScript客户端代理代码 |
|||
- Axios HTTP客户端 |
|||
- Vben Admin集成 |
|||
- UniApp集成 |
|||
* 支持生成Flutter客户端代理代码 |
|||
- Dio HTTP客户端 |
|||
- REST服务集成 |
|||
* 支持生成视图代码 |
|||
- Vben Admin视图模板 |
|||
- Flutter GetX视图模板 |
|||
* 自定义ABP启动模板 |
|||
|
|||
## 反馈 |
|||
|
|||
有问题需要反馈？ |
|||
|
|||
- [Github问题](https://github.com/colinin/abp-next-admin/issues) |
|||
|
|||
[English](./README.md) |
|||
@ -0,0 +1,37 @@ |
|||
# LINGYUN.Abp.Aliyun.Features |
|||
|
|||
Alibaba Cloud service feature management module. |
|||
|
|||
## Features |
|||
|
|||
* Provides feature definitions and management for Alibaba Cloud services |
|||
* Supports enabling/disabling Alibaba Cloud service features |
|||
* Integration with ABP feature management system |
|||
|
|||
## Module Reference |
|||
|
|||
```csharp |
|||
[DependsOn(typeof(AbpAliyunFeaturesModule))] |
|||
public class YouProjectModule : AbpModule |
|||
{ |
|||
// other |
|||
} |
|||
``` |
|||
|
|||
## Feature Items |
|||
|
|||
* **Features:AlibabaCloud** - Alibaba Cloud service feature group |
|||
* **Features:AlibabaCloud:IsEnabled** - Enable/Disable Alibaba Cloud services |
|||
* Default value: false |
|||
* Description: Enable to give the application Alibaba Cloud service capabilities |
|||
|
|||
## Configuration Items |
|||
|
|||
This module is mainly used for feature definition and does not contain configuration items. |
|||
|
|||
## Notes |
|||
|
|||
* This module needs to be used in conjunction with the LINGYUN.Abp.Aliyun module |
|||
* After enabling Alibaba Cloud service features, you still need to configure the corresponding service parameters in the LINGYUN.Abp.Aliyun module |
|||
|
|||
[查看中文文档](README.md) |
|||
@ -0,0 +1,37 @@ |
|||
# LINGYUN.Abp.Aliyun.Features |
|||
|
|||
阿里云服务功能管理模块。 |
|||
|
|||
## 功能特性 |
|||
|
|||
* 提供阿里云服务的功能定义和管理 |
|||
* 支持启用/禁用阿里云服务功能 |
|||
* 与ABP功能管理系统集成 |
|||
|
|||
## 模块引用 |
|||
|
|||
```csharp |
|||
[DependsOn(typeof(AbpAliyunFeaturesModule))] |
|||
public class YouProjectModule : AbpModule |
|||
{ |
|||
// other |
|||
} |
|||
``` |
|||
|
|||
## 功能项 |
|||
|
|||
* **Features:AlibabaCloud** - 阿里云服务功能组 |
|||
* **Features:AlibabaCloud:IsEnabled** - 是否启用阿里云服务 |
|||
* 默认值：false |
|||
* 描述：启用使应用程序拥有阿里云服务的能力 |
|||
|
|||
## 配置项 |
|||
|
|||
此模块主要用于功能定义，不包含配置项。 |
|||
|
|||
## 注意 |
|||
|
|||
* 此模块需要与LINGYUN.Abp.Aliyun模块配合使用 |
|||
* 启用阿里云服务功能后，还需要在LINGYUN.Abp.Aliyun模块中配置相应的服务参数 |
|||
|
|||
[点击查看英文文档](README.EN.md) |
|||
@ -0,0 +1,23 @@ |
|||
# LINGYUN.Abp.Aliyun.SettingManagement |
|||
|
|||
Alibaba Cloud configuration management module. By referencing this module, you can manage Alibaba Cloud-related configurations and access the API interfaces published through the gateway aggregation. |
|||
|
|||
API endpoint: api/setting-management/aliyun |
|||
|
|||
## Module Reference |
|||
|
|||
The module should be referenced as needed. It is recommended to reference this module in the configuration management hosting service. |
|||
|
|||
```csharp |
|||
[DependsOn(typeof(AbpAliyunSettingManagementModule))] |
|||
public class YouProjectModule : AbpModule |
|||
{ |
|||
// other |
|||
} |
|||
``` |
|||
|
|||
## Note |
|||
|
|||
Since the background management module is responsible for managing all configurations, this module only provides query interfaces. |
|||
|
|||
[查看中文文档](README.md) |
|||
@ -0,0 +1,86 @@ |
|||
# LINGYUN.Abp.Aliyun |
|||
|
|||
Alibaba Cloud SDK integration module. |
|||
|
|||
Reference: [Alibaba Cloud API Documentation](https://help.aliyun.com/document_detail/28763.html) |
|||
|
|||
## Features |
|||
|
|||
* Provides basic SDK integration for Alibaba Cloud services |
|||
* Supports Alibaba Cloud RAM (Resource Access Management) authentication |
|||
* Supports STS Token access |
|||
* Supports Alibaba Cloud SMS service |
|||
* Supports Alibaba Cloud Object Storage Service (OSS) |
|||
* Provides distributed cache support for optimizing high concurrency scenarios |
|||
|
|||
## Module Reference |
|||
|
|||
```csharp |
|||
[DependsOn(typeof(AbpAliyunModule))] |
|||
public class YouProjectModule : AbpModule |
|||
{ |
|||
// other |
|||
} |
|||
``` |
|||
|
|||
## Configuration Items |
|||
|
|||
### Authentication Configuration |
|||
|
|||
* **AliyunSettingNames.Authorization.RegionId** |
|||
* Description: Alibaba Cloud service region |
|||
* Type: Optional |
|||
* Default value: default |
|||
* Example: oss-cn-hangzhou |
|||
|
|||
* **AliyunSettingNames.Authorization.AccessKeyId** |
|||
* Description: AccessKey ID of Alibaba Cloud RAM account |
|||
* Type: Required |
|||
* How to get: Access Alibaba Cloud Console - Access Control |
|||
|
|||
* **AliyunSettingNames.Authorization.AccessKeySecret** |
|||
* Description: AccessKey Secret of RAM account |
|||
* Type: Required |
|||
* How to get: Access Alibaba Cloud Console - Access Control |
|||
|
|||
### STS Token Configuration |
|||
|
|||
* **AliyunSettingNames.Authorization.UseSecurityTokenService** |
|||
* Description: Whether to use STS Token access |
|||
* Type: Optional |
|||
* Default value: false |
|||
* Recommendation: Recommended to enable for improved security |
|||
|
|||
* **AliyunSettingNames.Authorization.RamRoleArn** |
|||
* Description: Alibaba Cloud RAM role ARN |
|||
* Type: Required when STS Token is enabled |
|||
* Format: acs:ram::$accountID:role/$roleName |
|||
|
|||
* **AliyunSettingNames.Authorization.RoleSessionName** |
|||
* Description: Custom token name |
|||
* Type: Optional |
|||
* Usage: For access auditing |
|||
|
|||
* **AliyunSettingNames.Authorization.DurationSeconds** |
|||
* Description: Token expiration time |
|||
* Type: Optional |
|||
* Default value: 3000 |
|||
* Unit: Seconds |
|||
|
|||
* **AliyunSettingNames.Authorization.Policy** |
|||
* Description: Permission policy |
|||
* Type: Optional |
|||
* Format: JSON string |
|||
|
|||
## Performance Optimization |
|||
|
|||
* In high concurrency scenarios, it is recommended to enable distributed caching to improve performance |
|||
* When using STS Token, the token will be automatically cached until expiration |
|||
* It is recommended to set DurationSeconds reasonably to avoid frequent token refreshes |
|||
|
|||
## Related Modules |
|||
|
|||
* [LINGYUN.Abp.Aliyun.SettingManagement](../LINGYUN.Abp.Aliyun.SettingManagement/README.md) - Provides configuration management functionality |
|||
* [LINGYUN.Abp.Aliyun.Features](../LINGYUN.Abp.Aliyun.Features/README.md) - Provides feature management functionality |
|||
|
|||
[查看中文文档](README.md) |
|||
@ -0,0 +1,85 @@ |
|||
# LINGYUN.Abp.BlobStoring.Aliyun |
|||
|
|||
Aliyun OSS implementation of the ABP framework's object storage provider **IBlobProvider**. |
|||
|
|||
## Features |
|||
|
|||
* Implements ABP's IBlobProvider interface using Aliyun OSS service |
|||
* Supports multi-tenant Blob storage |
|||
* Automatic Bucket creation |
|||
* Configurable Bucket access control |
|||
* STS Token access support |
|||
* Customizable Blob naming strategy |
|||
|
|||
## Module Reference |
|||
|
|||
First, define the **appsettings.json** file: |
|||
|
|||
```json |
|||
{ |
|||
"Aliyun": { |
|||
"OSS": { |
|||
"BucketName": "your-bucket-name", |
|||
"Endpoint": "http://oss-cn-shanghai.aliyuncs.com", |
|||
"CreateBucketIfNotExists": true |
|||
} |
|||
} |
|||
} |
|||
``` |
|||
|
|||
Then reference the module in your project: |
|||
|
|||
```csharp |
|||
[DependsOn(typeof(AbpBlobStoringAliyunModule))] |
|||
public class YouProjectModule : AbpModule |
|||
{ |
|||
// other |
|||
} |
|||
``` |
|||
|
|||
## Configuration |
|||
|
|||
### OSS Configuration |
|||
|
|||
* **BucketName** |
|||
* Description: OSS storage space name |
|||
* Type: Optional |
|||
* Default: Container name |
|||
|
|||
* **Endpoint** |
|||
* Description: OSS service access point |
|||
* Type: Required |
|||
* Example: http://oss-cn-shanghai.aliyuncs.com |
|||
|
|||
* **CreateBucketIfNotExists** |
|||
* Description: Whether to automatically create the bucket if it doesn't exist |
|||
* Type: Optional |
|||
* Default: false |
|||
|
|||
* **CreateBucketReferer** |
|||
* Description: Bucket access whitelist |
|||
* Type: Optional |
|||
|
|||
### Blob Naming Rules |
|||
|
|||
* Container (Bucket) naming rules: |
|||
* Length must be between 3-63 characters |
|||
* Can only contain lowercase letters, numbers, and hyphens |
|||
* Must start with a letter or number |
|||
* Cannot start or end with a hyphen |
|||
|
|||
* Blob naming rules: |
|||
* Tenant: `tenants/{tenantId}/{blobName}` |
|||
* Host: `host/{blobName}` |
|||
|
|||
## Performance Optimization |
|||
|
|||
* Uses distributed caching for STS Token storage |
|||
* Supports data redundancy configuration |
|||
* Configurable Bucket access control for enhanced security |
|||
|
|||
## Related Modules |
|||
|
|||
* [LINGYUN.Abp.Aliyun](../../cloud-aliyun/LINGYUN.Abp.Aliyun/README.md) - Provides Aliyun basic integration |
|||
|
|||
[点击查看中文文档](README.md) |
|||
Loading…
Reference in new issue