Skip to main content

Crate yang_base

Crate yang_base 

Source
Expand description

yang-base - YANG 基础库

提供插件管理、数据库访问、HTTP 客户端和 JWT Token 管理等核心功能。

§模块

  • plugin:插件管理模块
  • database:数据库管理模块(支持 MySQL 和 Redis)
  • http:HTTP 客户端模块(需启用 http feature)
  • token:JWT Token 管理模块(需启用 token feature)
  • error:错误处理模块
  • table:表配置系统模块
  • action:Action 系统模块

§Feature Gates

  • token:启用 JWT Token 管理功能(依赖 jsonwebtoken)
  • http:启用 HTTP 客户端功能(依赖 reqwest、serde_urlencoded)
  • mysql:启用 MySQL 数据库查询执行功能(依赖 sqlx)
  • redis:启用 Redis 全局访问功能(token 会自动启用它)
  • validator:启用正则表达式校验器(依赖 regex)
  • plugin-schema:启用插件 JSON Schema 配置验证(依赖 jsonschema)
  • admin-metadata:启用独立后台展示描述(不新增依赖、不改变 dispatch)

§快速开始

ⓘ
use yang_base::plugin::{Plugin, PluginManager};
use yang_base::database::{GlobalDatabase, GlobalRedis};
use yang_base::http::HttpClient;
use yang_base::token::TokenManager;
use yang_db::{DatabaseConfig, redis::RedisConfig};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 初始化插件管理器
    let plugin_manager = PluginManager::new();
     
    // 初始化全局 MySQL 数据库
    GlobalDatabase::init("mysql://user:pass@localhost/db", DatabaseConfig::default()).await?;
     
    // 初始化全局 Redis
    GlobalRedis::init("redis://127.0.0.1:6379", RedisConfig::default()).await?;
     
    // 初始化 HTTP 客户端
    HttpClient::init_global(30)?;
     
    // 使用 MySQL
    let users = GlobalDatabase::table("users")?
        .select::<User>()
        .await?;
     
    // 使用 Redis
    GlobalRedis::set("key", "value", None).await?;
    let value = GlobalRedis::get("key").await?;
     
    Ok(())
}

Re-exports§

pub use plugin::Plugin;
pub use plugin::PluginManager;
pub use plugin::PluginManagerBuilder;
pub use plugin::PluginRegistry;
pub use error::BaseError;
pub use error::ErrorCategory;
pub use error::Result;

Modules§

action
Action 系统模块
admin
可选后台展示元数据。
config
引擎配置(I4):从环境变量分层加载,遵循 12-factor。
database
数据库管理模块
error
错误处理模块
http
HTTP 客户端模块
lifecycle
引擎生命周期:编排式优雅停机(I3)。
observability
引擎可观测性配置(C4 收口)
plugin
插件管理模块
router
路由模块
table
表配置系统
token
JWT Token 管理模块

Constants§

VERSION
当前 yang-base crate 版本。

Derive Macros§

Action
为 struct 派生 TypedAction 实现,自动生成 ActionMeta 静态聚合。
TableEntity
为 struct 派生 TableEntity 实现,同时生成对应的 <Name>Field 和 <Name>Where 枚举。