Skip to main content

yang_base/
lib.rs

1//! yang-base - YANG 基础库
2//!
3//! 提供插件管理、数据库访问、HTTP 客户端和 JWT Token 管理等核心功能。
4//!
5//! # 模块
6//!
7//! - `plugin`:插件管理模块
8//! - `database`:数据库管理模块(支持 MySQL 和 Redis)
9//! - `http`:HTTP 客户端模块(需启用 `http` feature)
10//! - `token`:JWT Token 管理模块(需启用 `token` feature)
11//! - `error`:错误处理模块
12//! - `table`:表配置系统模块
13//! - `action`:Action 系统模块
14//!
15//! # Feature Gates
16//!
17//! - `token`:启用 JWT Token 管理功能(依赖 `jsonwebtoken`)
18//! - `http`:启用 HTTP 客户端功能(依赖 `reqwest`、`serde_urlencoded`)
19//! - `mysql`:启用 MySQL 数据库查询执行功能(依赖 `sqlx`)
20//! - `redis`:启用应用实例持有的 Redis 客户端(`token` 会自动启用它)
21//! - `validator`:启用正则表达式校验器(依赖 `regex`)
22//! - `plugin-schema`:启用插件 JSON Schema 配置验证(依赖 `jsonschema`)
23//! - `admin-metadata`:启用独立后台展示描述(不新增依赖、不改变 dispatch)
24//! - `transport-axum`:启用 Axum 0.8 HTTP 传输适配器(依赖 `axum`、`tower-http`)
25//!
26//! # 快速开始
27//!
28//! ```rust,ignore
29//! use yang_base::definition::{AppBuilder, AddonSpec};
30//! use yang_base::tools::ToolsBuilder;
31//! use yang_db::{Database, DatabaseConfig};
32//!
33//! #[tokio::main]
34//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
35//!     let database = Database::connect(
36//!         "mysql://user:pass@localhost/db",
37//!         DatabaseConfig::default(),
38//!     ).await?;
39//!     let tools = ToolsBuilder::new().mysql(database).build()?;
40//!     let app = AppBuilder::new()
41//!         .addon(AddonSpec::new(yang_base::addon!("account")))
42//!         .build(tools)?;
43//!     app.tools().mysql().health_check().await?;
44//!     Ok(())
45//! }
46//! ```
47
48// 强制公开 API 文档覆盖率检查:所有公开项必须有文档注释
49#![warn(missing_docs)]
50
51/// 当前 yang-base crate 版本。
52pub const VERSION: &str = env!("CARGO_PKG_VERSION");
53
54// 让派生宏内部的 `::yang_base::...` 路径在 yang-base 自身的测试中正常解析。
55extern crate self as yang_base;
56
57pub mod action;
58#[cfg(feature = "admin-metadata")]
59pub mod admin;
60pub mod config;
61pub mod database;
62pub mod definition;
63pub mod error;
64#[cfg(feature = "http")]
65pub mod http;
66pub mod lifecycle;
67pub mod observability;
68pub mod plugin;
69pub mod router;
70pub mod table;
71#[cfg(feature = "token")]
72pub mod token;
73pub mod tools;
74#[cfg(feature = "transport-axum")]
75pub mod transport;
76
77// 重新导出插件系统的核心类型,方便用户直接使用
78pub use plugin::{Plugin, PluginManager, PluginManagerBuilder, PluginRegistry};
79
80// 重新导出统一错误类型与 Result 别名,下游可直接写 yang_base::Result<T>
81pub use error::{BaseError, ErrorCategory, Result};
82
83// 重新导出派生宏
84pub use yang_base_derive::{params, Action};
85
86/// 直接生成原生 [`definition::Fields`];重复字段由临时结构体在编译期拒绝。
87#[macro_export]
88macro_rules! fields {
89    ($($name:ident => $builder:expr),* $(,)?) => {{
90        const _: () = {
91            $($crate::definition::__validate_field_literal(stringify!($name));)*
92        };
93        #[allow(dead_code)]
94        struct __YangFieldNames {
95            $($name: (),)*
96        }
97        let _ = __YangFieldNames { $($name: (),)* };
98        $crate::definition::Fields::new()
99            $(.field(
100                $crate::definition::FieldName::__from_validated_literal(stringify!($name)),
101                $builder,
102            ))*
103    }};
104}
105
106/// 编译期校验的 AddonName 字面量。
107#[macro_export]
108macro_rules! addon {
109    ($value:literal) => {{
110        const _: () = $crate::definition::__validate_segment_literal($value);
111        $crate::definition::AddonName::__from_validated_literal($value)
112    }};
113}
114
115/// 编译期校验的 ModuleName 字面量。
116#[macro_export]
117macro_rules! module {
118    ($value:literal) => {{
119        const _: () = $crate::definition::__validate_ref_literal($value);
120        $crate::definition::ModuleName::__from_validated_literal($value)
121    }};
122}
123
124/// 编译期校验的 TableName 字面量。
125#[macro_export]
126macro_rules! table {
127    ($value:literal) => {{
128        const _: () = $crate::definition::__validate_segment_literal($value);
129        $crate::definition::TableName::__from_validated_literal($value)
130    }};
131}
132
133/// 编译期校验的限定 FieldRef 字面量,例如 `field!("users.id")`。
134#[macro_export]
135macro_rules! field {
136    ($value:literal) => {{
137        const _: () = $crate::definition::__validate_ref_literal($value);
138        $crate::definition::FieldRef::__from_validated_literal($value)
139    }};
140}
141
142/// 编译期校验的限定 ActionRef 字面量,例如 `action!("account.user.login")`。
143#[macro_export]
144macro_rules! action {
145    ($value:literal) => {{
146        const _: () = $crate::definition::__validate_ref_literal($value);
147        $crate::definition::ActionRef::__from_validated_literal($value)
148    }};
149}
150
151/// 编译期校验的限定 ViewRef 字面量。
152#[macro_export]
153macro_rules! view {
154    ($value:literal) => {{
155        const _: () = $crate::definition::__validate_ref_literal($value);
156        $crate::definition::ViewRef::__from_validated_literal($value)
157    }};
158}
159
160/// 聚合原生 Modules;每个元素直接调用 Module::into_spec。
161#[macro_export]
162macro_rules! modules {
163    ($($module:expr),* $(,)?) => {{
164        $crate::definition::Modules::new()
165            $(.module($module))*
166    }};
167}
168
169/// 原子聚合 ActionSpec 与 Handler,不支持字符串 match。
170#[macro_export]
171macro_rules! actions {
172    ($($spec:expr => $handler:expr),* $(,)?) => {{
173        $crate::definition::Actions::new()
174            $(.action($spec, $handler))*
175    }};
176    ($($handler:expr),* $(,)?) => {{
177        $crate::definition::Actions::new()
178            $(.native($handler))*
179    }};
180}