Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

better error handle #14

Merged
merged 4 commits into from
Nov 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 6 additions & 39 deletions src/template/src/app_error.hbs
Original file line number Diff line number Diff line change
@@ -1,20 +1,4 @@
{{#if is_web_site}}
use salvo::{
async_trait,
http::ParseError,
prelude::{EndpointOutRegister, StatusCode},
writing::Json,
Depot, Request, Response, Writer,
};
{{else}}
use salvo::{
async_trait,
http::ParseError,
prelude::EndpointOutRegister,
writing::Json,
Depot, Request, Response, Writer,
};
{{/if}}
use salvo::http::ParseError;
{{#if is_mongodb}}
use mongodb::bson::document::ValueAccessError as MongoBsonAccessError;
use mongodb::bson::oid::Error as MongoBsonOidError;
Expand Down Expand Up @@ -52,25 +36,8 @@ pub enum AppError {
#[error("mongodb::bson::oid::Error`{0}`")]
MongoBsonOidError(#[from] MongoBsonOidError),
{{/if}}
}

pub type AppResult<T> = Result<T, AppError>;

#[async_trait]
impl Writer for AppError {
async fn write(mut self, _req: &mut Request, _depot: &mut Depot, res: &mut Response) {
{{#if is_web_site}}
res.stuff(StatusCode::INTERNAL_SERVER_ERROR, Json(self.to_string()));
{{else}}
res.render(Json(self.to_string()));
{{/if}}
}
}

impl EndpointOutRegister for AppError {
fn register(_components: &mut salvo::oapi::Components, operation: &mut salvo::oapi::Operation) {
operation
.responses
.insert("500".to_string(), salvo::oapi::Response::new("error"));
}
}
{{#if need_db_conn}}
#[error("ValidationError:`{0}`")]
ValidationError(#[from] validator::ValidationErrors),
{{/if}}
}
65 changes: 62 additions & 3 deletions src/template/src/app_response.hbs
Original file line number Diff line number Diff line change
@@ -1,6 +1,48 @@
use salvo::{prelude::StatusCode, writing::Json, Response};
use salvo::{
async_trait,
prelude::EndpointOutRegister,
writing::Json,
Depot, Request, Response, Writer, hyper::StatusCode,
};
use serde::Serialize;

use crate::app_error::AppError;

pub struct AppResponse<T>(pub AppResult<T>);

#[async_trait]
impl<T: Serialize + Default + Send> Writer for AppResponse<T> {
async fn write(self, req: &mut Request, depot: &mut Depot, res: &mut Response) {
match self.0 {
Ok(data) => Res::with_data(data).into_response(res),
Err(e) => e.write(req, depot, res).await,
}
}
}

impl<T: Serialize + Default + Send> EndpointOutRegister for AppResponse<T> {
fn register(_components: &mut salvo::oapi::Components, operation: &mut salvo::oapi::Operation) {
operation
.responses
.insert("0".to_string(), salvo::oapi::Response::new("success"));
operation
.responses
.insert("500".to_string(), salvo::oapi::Response::new("error"));
}
}

impl<T> From<AppResult<T>> for AppResponse<T> {
fn from(result: AppResult<T>) -> Self {
AppResponse(result)
}
}

impl<T> From<AppError> for AppResponse<T> {
fn from(result: AppError) -> Self {
AppResponse(Err(result))
}
}

#[derive(Debug, Serialize, Default)]
pub struct Res<T> {
pub code: i32,
Expand All @@ -17,15 +59,15 @@ pub struct ErrRes {
impl<T: Serialize + Send + Default> Res<T> {
pub fn with_data(data: T) -> Self {
Self {
code: 200,
code: 0,
data,
msg: "success".to_string(),
}
}
#[allow(dead_code)]
pub fn with_data_msg(data: T, msg: &str) -> Self {
Self {
code: 200,
code: 0,
data,
msg: msg.to_string(),
}
Expand All @@ -51,3 +93,20 @@ impl ErrRes {
res.stuff(StatusCode::INTERNAL_SERVER_ERROR, Json(self));
}
}

pub type AppResult<T> = Result<T, AppError>;

#[async_trait]
impl Writer for AppError {
async fn write(mut self, _req: &mut Request, _depot: &mut Depot, res: &mut Response) {
ErrRes::with_err(&self.to_string()).into_response(res)
}
}

impl EndpointOutRegister for AppError {
fn register(_components: &mut salvo::oapi::Components, operation: &mut salvo::oapi::Operation) {
operation
.responses
.insert("500".to_string(), salvo::oapi::Response::new("error"));
}
}
4 changes: 3 additions & 1 deletion src/template/src/dtos/user.hbs
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
use salvo::prelude::{ToSchema, Extractible};
use serde::{Deserialize, Serialize};
use validator::Validate;

#[derive(Deserialize, Debug, ToSchema, Default)]
#[derive(Deserialize, Debug, Validate, ToSchema, Default)]
pub struct UserAddRequest {
#[validate(length(min = 5, message = "username length must be greater than 5"))]
pub username: String,
pub password: String,
}
Expand Down
2 changes: 1 addition & 1 deletion src/template/src/routers/demo.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use salvo::{endpoint, writing::Text, Request, Response};
{{else}}
use salvo::endpoint;
{{/if}}
use crate::app_error::AppResult;
use crate::app_response::AppResult;
{{#if is_web_site}}

#[derive(Template)]
Expand Down
98 changes: 44 additions & 54 deletions src/template/src/routers/user.hbs
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
{{#if is_web_site}}
use crate::{
app_error::AppResult,
app_response::{ErrRes, Res},
dtos::user::{UserAddRequest, UserLoginRequest, UserLoginResponse, UserUpdateRequest},
app_response::{AppResponse, AppResult, ErrRes},
dtos::user::{
UserAddRequest, UserLoginRequest, UserLoginResponse, UserResponse, UserUpdateRequest,
},
middleware::jwt::decode_token,
services::user,
};
Expand All @@ -19,7 +20,7 @@ use salvo::{
#[template(path = "login.html")]
struct LoginTemplate {}

#[endpoint( tags("comm"),)]
#[endpoint(tags("comm"))]
pub async fn login_page(res: &mut Response) -> AppResult<()> {
let cookies = res.cookies();
let cookie = cookies.get("jwt_token");
Expand All @@ -35,7 +36,31 @@ pub async fn login_page(res: &mut Response) -> AppResult<()> {
res.render(Text::Html(hello_tmpl.render().unwrap()));
Ok(())
}
#[endpoint( tags("comm"),)]

#[derive(Template)]
#[template(path = "user_list_page.html")]
pub struct UserListPageTemplate {}

#[derive(Template)]
#[template(path = "user_list.html")]
pub struct UserListTemplate {}

#[endpoint]
pub async fn user_list_page(req: &mut Request, res: &mut Response) -> AppResult<()> {
let is_fragment = req.headers().get("X-Fragment-Header");
match is_fragment {
Some(_) => {
let hello_tmpl = UserListTemplate {};
res.render(Text::Html(hello_tmpl.render().unwrap()));
}
None => {
let hello_tmpl = UserListPageTemplate {};
res.render(Text::Html(hello_tmpl.render().unwrap()));
}
}
Ok(())
}
#[endpoint(tags("comm"))]
pub async fn post_login(req: JsonBody<UserLoginRequest>, res: &mut Response) {
let result: AppResult<UserLoginResponse> = user::login(req.0).await;
match result {
Expand All @@ -51,72 +76,37 @@ pub async fn post_login(req: JsonBody<UserLoginRequest>, res: &mut Response) {
}
}

#[endpoint( tags("users"))]
pub async fn post_add_user(req: JsonBody<UserAddRequest>, res: &mut Response) {
let result = user::add_user(req.0).await;
match result {
Ok(data) => Res::with_data(data).into_response(res),
Err(e) => ErrRes::with_err(&e.to_string()).into_response(res),
}
#[endpoint(tags("users"))]
pub async fn post_add_user(new_user: JsonBody<UserAddRequest>) -> AppResponse<UserResponse> {
let result = user::add_user(new_user.0).await;
AppResponse(result)
}

#[endpoint( tags("users"),
parameters(
("id", description = "user id"),
))]
pub async fn put_update_user(req: &mut Request, res: &mut Response) {
let req: UserUpdateRequest = req.extract().await.unwrap();
pub async fn put_update_user(req: &mut Request) -> AppResult<AppResponse<UserResponse>> {
let req: UserUpdateRequest = req.extract().await?;
let result = user::update_user(req).await;
match result {
Ok(data) => Res::with_data(data).into_response(res),
Err(e) => ErrRes::with_err(&e.to_string()).into_response(res),
}
Ok(AppResponse(result))
}

#[endpoint( tags("users"),)]
pub async fn delete_user(id: PathParam<String>, res: &mut Response) {
#[endpoint(tags("users"))]
pub async fn delete_user(id: PathParam<String>) -> AppResponse<()> {
let result = user::delete_user(id.0).await;
match result {
Ok(_) => Res::with_data(()).into_response(res),
Err(e) => ErrRes::with_err(&e.to_string()).into_response(res),
}
AppResponse(result)
}

#[endpoint( tags("users"),)]
pub async fn get_users(res: &mut Response) {
#[endpoint(tags("users"))]
pub async fn get_users() -> AppResponse<Vec<UserResponse>> {
let result = user::users().await;
match result {
Ok(data) => Res::with_data(data).into_response(res),
Err(e) => ErrRes::with_err(&e.to_string()).into_response(res),
}
AppResponse(result)
}

#[derive(Template)]
#[template(path = "user_list_page.html")]
pub struct UserListPageTemplate {}

#[derive(Template)]
#[template(path = "user_list.html")]
pub struct UserListTemplate {}

#[endpoint]
pub async fn user_list_page(req: &mut Request, res: &mut Response) -> AppResult<()> {
let is_fragment = req.headers().get("X-Fragment-Header");
match is_fragment {
Some(_) => {
let hello_tmpl = UserListTemplate {};
res.render(Text::Html(hello_tmpl.render().unwrap()));
}
None => {
let hello_tmpl = UserListPageTemplate {};
res.render(Text::Html(hello_tmpl.render().unwrap()));
}
}
Ok(())
}
{{else}}
use crate::{
app_error::AppResult,
app_response::AppResult,
app_response::{ErrRes, Res},
dtos::user::{UserAddRequest, UserLoginRequest, UserLoginResponse, UserUpdateRequest},
services::user,
Expand Down
28 changes: 15 additions & 13 deletions src/template/src/services/user.hbs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{#if is_sea_orm_or_sqlx}}
{{#if is_sqlx}}
use crate::{
app_error::AppResult,
app_response::AppResult,
db::DB,
dtos::user::{
UserAddRequest, UserLoginRequest, UserLoginResponse, UserResponse,
Expand All @@ -14,7 +14,7 @@ use crate::{
{{/if}}
{{#if is_sea_orm}}
use crate::{
app_error::AppResult,
app_response::AppResult,
db::DB,
dtos::user::{
UserAddRequest, UserLoginRequest, UserLoginResponse, UserResponse,
Expand Down Expand Up @@ -223,7 +223,7 @@ use uuid::Uuid;

use crate::schema::users::dsl::users as diesel_users;
use crate::{
app_error::AppResult,
app_response::AppResult,
db::establish_connection,
dtos::user::{
UserAddRequest, UserLoginRequest, UserLoginResponse, UserResponse, UserUpdateRequest,
Expand Down Expand Up @@ -355,7 +355,7 @@ pub async fn users() -> AppResult<Vec<UserResponse>> {
use uuid::Uuid;

use crate::{
app_error::AppResult,
app_response::AppResult,
dtos::user::{
UserAddRequest, UserLoginRequest, UserLoginResponse, UserResponse, UserUpdateRequest,
},
Expand Down Expand Up @@ -436,26 +436,28 @@ pub async fn users() -> AppResult<Vec<UserResponse>> {
}
{{/if}}
{{#if is_mongodb}}
use std::str::FromStr;
use futures_util::StreamExt;
use mongodb::{
bson::{doc, oid::ObjectId, Document},
Collection,
};
use crate::{
app_error::AppResult,
app_response::AppResult,
db::{COLL_NAME, DB_NAME, MONGODB_CLIENT},
dtos::user::{
UserAddRequest, UserLoginRequest, UserLoginResponse, UserResponse, UserUpdateRequest,
},
middleware::jwt::get_token,
utils::rand_utils,
};
use futures_util::StreamExt;
use mongodb::{
bson::{doc, oid::ObjectId, Document},
Collection,
};
use std::str::FromStr;
use validator::Validate;

pub async fn add_user(req: UserAddRequest) -> AppResult<UserResponse> {
req.validate()?;
let db = MONGODB_CLIENT
.get()
.ok_or(anyhow::anyhow!("{{database_connection_failed}}"))?;
.ok_or(anyhow::anyhow!("数据库连接失败"))?;
let coll_users = db.database(DB_NAME).collection::<Document>(COLL_NAME);

let user = doc! {
Expand All @@ -466,7 +468,7 @@ pub async fn add_user(req: UserAddRequest) -> AppResult<UserResponse> {
let user = coll_users
.find_one(user, None)
.await?
.ok_or(anyhow::anyhow!("{{user_does_not_exist}}"))?;
.ok_or(anyhow::anyhow!("用户不存在"))?;
Ok(UserResponse {
id: user.get_object_id("_id")?.to_string(),
username: user.get_str("username")?.to_string(),
Expand Down
4 changes: 4 additions & 0 deletions src/utils/create_project.rs
Original file line number Diff line number Diff line change
Expand Up @@ -694,6 +694,10 @@ fn handle_dependencies(
conn_type: DbConnectionType,
) {
if need_db_conn {
dependencies["validator"] = json!({
"version": "0.16",
"features": ["derive"]
});
match (conn_type, db_type) {
(DbConnectionType::Sqlx, DbType::Mysql) => {
dependencies["sqlx"] = json!({
Expand Down
Loading