Zino开发框架快速入门

简介: ​本文将以zino仓库下的examples/axum-app为例,详细讲解怎么使用zino框架快速开发一个后端API服务。

本文将以zino仓库下的examples/axum-app为例,详细讲解怎么使用zino框架快速开发一个后端API服务。


首先是使用cargo new axum-app --bin新建一个项目,然后在Cargo.toml中添加以下依赖:

这里我们都使用线上的版本,对于ORM选用MySQL(如果是PostgreSQL就换成orm-postgres)。进而我们在src目录创建controllermodelrouter三个模块(此时mod.rs中都还是空文件),在main.rs中添加以下代码:

注意logs目录是应用运行时自动生成的。运行cargo run(需要nightly工具链),此时已经能正常启动了,在终端里你应该能看到类似于以下的输出:

如果不指定配置文件的话,默认运行端口就是6080。当然,目前我们还没手动注册任何路由,你唯一能看到的就是框架默认注册的OpenAPI文档页面:

下一步我们来添加配置文件。在项目目录下添加config目录(注意不是src目录下,因为配置文件不属于源代码),并为开发环境dev和生产环境prod创建两个配置文件:

这里我们新添加了一个debug服务器标签,绑定端口6070(如果存在debug标签,调试用的API文档路由就会注册到这个对应的端口)。在数据库配置部分,我们指定了数据表创建时的namespace前缀。对于MySQL连接的配置,密码可以先写成明文,实际运行之后终端里会提示你改成框架加密之后的。需要注意的是,zino框架的ORM是惰性连接的,也就是说只有在需要查询的时候才会去连接。


对于配置文件的加载,可以通过cargo run -- --env=prod来指定,也可以设置环境变量ZINO_APP_ENV。如果不指定,运行cargo run时默认为dev,运行cargo run --release时默认为prod


下面我们在model目录下定义两个模型:UserTag。这个写法都是模式化的,我们只以Tag模型为例:

useserde::{Deserialize, Serialize};
usezino::prelude::*;
usezino_derive::{ModelAccessor, ModelHooks, Schema};
#[derive(Debug, Clone, Default, Serialize, Deserialize, Schema, ModelAccessor, ModelHooks)]#[serde(default)]pubstructTag {
// Basic fields.#[schema(primary_key, auto_increment, readonly)]id: i64,
#[schema(not_null, index_type = "text")]name: String,
#[schema(default_value = "Active", index_type = "hash")]status: String,
#[schema(index_type = "text")]description: String,
// Info fields.#[schema(not_null)]category: String,
#[schema(reference = "Tag")]parent_id: Option<i64>,
// Revisions.#[schema(readonly, default_value = "now", index_type = "btree")]created_at: DateTime,
#[schema(default_value = "now", index_type = "btree")]updated_at: DateTime,
version: u64,
}
implModelforTag {
fnread_map(&mutself, data: &Map) ->Validation {
let mutvalidation=Validation::new();
ifletSome(result) =data.parse_i64("id") {
matchresult {
Ok(id) =>self.id=id,
Err(err) =>validation.record_fail("id", err),
            }
        }
ifletSome(name) =data.parse_string("name") {
self.name=name.into_owned();
        }
ifletSome(category) =data.parse_string("category") {
self.category=category.into_owned();
        }
ifletSome(result) =data.parse_i64("parent_id") {
matchresult {
Ok(parent_id) =>self.parent_id=Some(parent_id),
Err(err) =>validation.record_fail("parent_id", err),
            }
        }
validation    }
}

虽然代码略有点长,但思路其实挺简单:就是定义一个结构体,通过自动推导或手动实现这7个trait:Default, Serialize, Deserialize, Schema, ModelAccessor, ModelHooks, Model。实际上,大部分情况下我们往往都只需要手动实现Model,这个决定了怎么从前端传过来的数据来构造模型。当然,Model这个trait也是可以自动推导的,只是目前还没那么完善。


模型里的字段是和数据表对应的,如果数据表不存在则会自动创建,如果新增字段也会自动添加(当然,数据表里的字段可以比模型里的多)。一旦定义好模型,原则上我们可以不用写任何controller就能直接得到增删改查之类的接口,这是通过DefaultController来实现的:

使用起来也很简单,直接在router/mod.rs里引用就行:

当然,具体路由的pathmethod还是要自己指定的,这里用到的就是axum框架标准的路由写法,你也可以选择自行实现一部分controller。如果你还需要一些中间件,也是按照axum框架的标准写法,在这里加载。

最后把这个路由注册到main()函数里就行了:

fnmain() {
zino::Cluster::boot()
        .register(router::routes())
        .run(Vec::new())
}

这样你就已经生成了14个API接口!至于API文档,我们是和实现分离的,需要写到独立的文件里,这个放到以后再讲。

目录
相关文章
|
网络安全 PHP
cURL error 60: SSL certificate problem: self signed certificate in certificate
一、问题 cURL error 60: SSL certificate problem: self signed certificate in certificate chain - 服务器http302 出现这个一般是自签名证书的问题
3585 0
|
缓存 Rust 前端开发
【一起学Rust | 框架篇 | Tauri2.0框架】Tauri2.0环境搭建与项目创建
【一起学Rust | 框架篇 | Tauri2.0框架】Tauri2.0环境搭建与项目创建
1627 0
|
消息中间件 监控 Java
查询Kafka生产者是否连接到Kafka服务
查询Kafka生产者是否连接到Kafka服务
596 2
|
12月前
|
存储 人工智能 C语言
C语言程序设计核心详解 第六章 数组_一维数组_二维数组_字符数组详解
本章介绍了C语言中的数组概念及应用。数组是一种存储同一类型数据的线性结构,通过下标访问元素。一维数组定义需指定长度,如`int a[10]`,并遵循命名规则。数组元素初始化可使用 `{}`,多余初值补0,少则随机。二维数组扩展了维度,定义形式为`int a[3][4]`,按行优先顺序存储。字符数组用于存储字符串,初始化时需添加结束符`\0`。此外,介绍了字符串处理函数,如`strcat()`、`strcpy()`、`strcmp()` 和 `strlen()`,用于拼接、复制、比较和计算字符串长度。
403 4
|
XML 搜索推荐 API
通义千问API:让大模型使用各种工具
本章我们将通过一个简单的例子,揭示基于LangChain的Agent开发的秘密,从而了解如何扩展大模型的能力。
通义千问API:让大模型使用各种工具
|
缓存 搜索推荐 Java
Java中的服务器端渲染(SSR)原理与实现
Java中的服务器端渲染(SSR)原理与实现
|
前端开发 数据安全/隐私保护
简洁好看的登录页面
这是一个简洁美观的登录页面设计,包含HTML和CSS代码。页面背景为渐变色,中央有一个白色的登录框,内含账号和密码输入字段、登录按钮以及注册链接。登录框下方有动态的正方形和圆形元素动画,通过CSS关键帧动画实现旋转和透明度变化。
260 1
|
敏捷开发 Java 测试技术
「架构」模型驱动架构设计方法及其运用
本文探讨了MDA在软件开发中的应用,从需求分析到测试,使用UML建模功能需求,通过PIM设计架构,自动生成代码以减少错误。MDA提升了可维护性、可扩展性和可移植性,通过工具如Enterprise Architect和Eclipse MDT支持自动化转换。虽然有挑战,如模型创建和平台转换,但结合敏捷方法和适当工具能有效解决,从而提高开发效率和软件质量。
1153 0
「架构」模型驱动架构设计方法及其运用
|
编译器 C语言 C++
【C语言】calloc()函数详解(动态内存开辟函数)
【C语言】calloc()函数详解(动态内存开辟函数)
251 0
|
SQL Java 数据库连接
一般文章让你了解mybatis,以及如今在Java开发的地位!
一般文章让你了解mybatis,以及如今在Java开发的地位!
392 0