Skip to main content

Crate yang_base

Crate yang_base 

Source
Expand description

yang-base - YANG 基础库

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

§模块

  • plugin:插件管理模块
  • database:数据库管理模块(MySQL / PostgreSQL 后端运行时、声明式 Schema 同步与事务句柄)
  • 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)
  • postgres:启用 PostgreSQL 后端(AnyDatabase、Record 解码、声明式 schema_sync, 以及 TableQuery / 内置 CRUD 的受保护查询与事务执行)。
  • redis:启用应用实例持有的 Redis 客户端(token 会自动启用它)
  • validator:启用正则表达式校验器(依赖 regex)
  • plugin-schema:启用插件 JSON Schema 配置验证(依赖 jsonschema)
  • admin-metadata:启用独立后台展示描述(不新增依赖、不改变 dispatch)
  • transport-axum:启用 Axum 0.8 HTTP 传输适配器(依赖 axum、tower-http)

§快速开始

ⓘ
use yang_base::definition::{AppBuilder, AddonSpec};
use yang_base::tools::ToolsBuilder;
use yang_db::{Database, DatabaseConfig};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let database = Database::connect(
        "mysql://user:pass@localhost/db",
        DatabaseConfig::default(),
    ).await?;
    let tools = ToolsBuilder::new().mysql(database).build()?;
    let app = AppBuilder::new()
        .addon(AddonSpec::new(yang_base::addon!("account")))
        .build(tools)?;
    app.tools().mysql().health_check().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
可选后台展示元数据。
cache
通用 Redis 缓存与固定窗口限流门面(feature = "redis")。
config
引擎配置(I4):从环境变量分层加载,遵循 12-factor。
database
数据库管理模块
datasource
逻辑数据源标识。
definition
YANG 原生定义内核。
error
错误处理模块
http
HTTP 客户端模块
lifecycle
引擎生命周期:编排式优雅停机(I3)。
observability
引擎可观测性配置(C4 收口)
plugin
插件管理模块
router
传输无关的 Action 中间件。
table
Schema-first 表系统
token
JWT Token 管理模块
tools
应用资源的显式所有权与统一生命周期。
transport
传输适配器:把冻结的 BuiltApp 暴露到具体网络协议。

Macros§

action
编译期校验的限定 ActionRef 字面量,例如 action!("account.user.login")。
action_name
编译期校验的 ActionName 字面量,例如 action_name!("login")。
actions
原子聚合 ActionSpec 与 Handler,不支持字符串 match。
addon
编译期校验的 AddonName 字面量。
context_key
创建静态类型化上下文键。
field
编译期校验的限定 FieldRef 字面量,例如 field!("users.id")。
fields
直接生成原生 definition::Fields;重复字段由临时结构体在编译期拒绝。
module
编译期校验的 ModuleName 字面量。
modules
聚合原生 Modules;每个元素直接调用 Module::into_spec。
params
一次声明强类型输入结构与其唯一原生 Params 定义。
table
编译期校验的 TableName 字面量。
view
编译期校验的限定 ViewRef 字面量。

Constants§

VERSION
当前 yang-base crate 版本。

Derive Macros§

Action
为 struct 派生 TypedAction 实现,自动生成 ActionMeta 静态聚合。