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

目录
相关文章
|
2月前
|
开发框架 Java API
「SpringBrick快速入门指南」:一款基于Spring Boot的高级插件化开发框架
「SpringBrick快速入门指南」:一款基于Spring Boot的高级插件化开发框架
78 0
|
开发框架 JavaScript 前端开发
快速入门uniapp——从环境搭建到项目实践(上)
快速入门uniapp——从环境搭建到项目实践(上)
1868 0
快速入门uniapp——从环境搭建到项目实践(上)
|
敏捷开发 JavaScript 小程序
快速入门uniapp——从环境搭建到项目实践(下)
快速入门uniapp——从环境搭建到项目实践(下)
233 0
|
NoSQL Java 数据库连接
web开发简介|学习笔记
快速学习web开发简介
web开发简介|学习笔记
|
SQL 前端开发 Java
全栈开发实战|SSM框架整合开发
全栈开发实战|SSM框架整合开发
151 0
全栈开发实战|SSM框架整合开发
|
设计模式 开发框架 自然语言处理
dlvm-netcore 开源框架后台管理
程序开发人员都想找到一个快速开发框架,网络上的框架也有很多。一般都是静态页面的居多并没有后台功能及代码,有些有代码的也十分简单或复杂不能很容易的扩展,想找到一个完美的权限分配功能并能和您创建的功能模块及操作按钮对应的框架就更难了。
127 0
dlvm-netcore 开源框架后台管理
|
消息中间件 监控 Java
开发者学堂课程干货总结——Spring Cloud微服务架构设计与开发实战(二十二)
Spring Cloud微服务架构设计与开发实战课时3.1—Spring Cloud Alibaba微服务体系 。Java Spring Cloud是全球范围内最成熟、最完善、最流行的微服务架构方案体系。被众多的互联网大公司采用,包括阿里巴巴、腾讯、支付宝、网易、IBM、谷歌、京东、百度、滴滴等。电子书+视频为同学带来最佳学习效果,文字、课程链接、图谱地址统统为大家放送了哦!
开发者学堂课程干货总结——Spring Cloud微服务架构设计与开发实战(二十二)
|
监控 Dubbo Java
开发者学堂课程干货总结——Spring Cloud微服务架构设计与开发实战(二十七)
Spring Cloud微服务架构设计与开发实战课时3.6—Spring Cloud实战Sentinel熔断限流。Java Spring Cloud是全球范围内最成熟、最完善、最流行的微服务架构方案体系。被众多的互联网大公司采用,包括阿里巴巴、腾讯、支付宝、网易、IBM、谷歌、京东、百度、滴滴等。电子书+视频为同学带来最佳学习效果,文字、课程链接、图谱地址统统为大家放送了哦!
开发者学堂课程干货总结——Spring Cloud微服务架构设计与开发实战(二十七)
|
消息中间件 Dubbo Java
开发者学堂课程干货总结——Spring Cloud微服务架构设计与开发实战(二十九)
Spring Cloud微服务架构设计与开发实战课时3.8—阿里巴巴开源微服务分布式事务框架。Java Spring Cloud是全球范围内最成熟、最完善、最流行的微服务架构方案体系。被众多的互联网大公司采用,包括阿里巴巴、腾讯、支付宝、网易、IBM、谷歌、京东、百度、滴滴等。电子书+视频为同学带来最佳学习效果,文字、课程链接、图谱地址统统为大家放送了哦!
开发者学堂课程干货总结——Spring Cloud微服务架构设计与开发实战(二十九)
|
负载均衡 Java Nacos
开发者学堂课程干货总结——Spring Cloud微服务架构设计与开发实战(二十五)
Spring Cloud微服务架构设计与开发实战课时3.4—Spring Cloud 客户端Feign集成Nacos 。Java Spring Cloud是全球范围内最成熟、最完善、最流行的微服务架构方案体系。被众多的互联网大公司采用,包括阿里巴巴、腾讯、支付宝、网易、IBM、谷歌、京东、百度、滴滴等。电子书+视频为同学带来最佳学习效果,文字、课程链接、图谱地址统统为大家放送了哦!
开发者学堂课程干货总结——Spring Cloud微服务架构设计与开发实战(二十五)