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文档,我们是和实现分离的,需要写到独立的文件里,这个放到以后再讲。

目录
相关文章
|
1月前
|
开发框架 Java API
「SpringBrick快速入门指南」:一款基于Spring Boot的高级插件化开发框架
「SpringBrick快速入门指南」:一款基于Spring Boot的高级插件化开发框架
60 0
|
5月前
|
Java Maven 容器
快速入门Web开发(下)(2)
快速入门Web开发(下)(2)
25 2
|
6月前
|
开发框架 Java 数据安全/隐私保护
SpringBlade、若依框架和人人开源框架对比
SpringBlade、若依框架和人人开源框架对比
|
开发框架 小程序 JavaScript
【小程序开发框架选型】7大小程序开发框架,哪一个更适合你?
小程序越来越流行,微信小程序、百度小程序、支付宝小程序、头条小程序等等不断涌入我们的生活,随着小程序的火爆,各种小程序框架不断出现。小程序开发公认的7个小程序开发框架: 原生、uni-app、taro、mpvue、wepy、chameleon、remax。各有利弊。
836 0
|
存储 人工智能 安全
|
开发框架 JavaScript 前端开发
快速入门uniapp——从环境搭建到项目实践(上)
快速入门uniapp——从环境搭建到项目实践(上)
1839 0
快速入门uniapp——从环境搭建到项目实践(上)
|
敏捷开发 JavaScript 小程序
快速入门uniapp——从环境搭建到项目实践(下)
快速入门uniapp——从环境搭建到项目实践(下)
229 0
|
存储 JSON 小程序
小程序云开发实战总结|快速上手&场景实战(二)
基于微信小程序云开发,我搭建了两款百科类的小程序 我会从云开发基本能力与场景实战两个方面来总结一篇我的实战过程中的心得 希望这篇文章可以对刚接触云开发的掘友有所帮助。
223 1
小程序云开发实战总结|快速上手&场景实战(二)
|
NoSQL Java 数据库连接
web开发简介|学习笔记
快速学习web开发简介
web开发简介|学习笔记
|
存储 JSON 小程序
小程序云开发实战总结|快速上手&场景实战(一)
基于微信小程序云开发,我搭建了两款百科类的小程序 我会从云开发基本能力与场景实战两个方面来总结一篇我的实战过程中的心得 希望这篇文章可以对刚接触云开发的掘友有所帮助。
474 0
小程序云开发实战总结|快速上手&场景实战(一)
下一篇
无影云桌面