async-graphql/docs/zh-CN/src/custom_scalars.md

59 lines
1.5 KiB
Markdown
Raw Normal View History

2020-04-15 03:15:30 +00:00
# 自定义标量
`Async-graphql`已经内置了绝大部分常用的标量类型,同时你也能自定义标量。
实现`Async-graphql::Scalar`即可自定义一个标量,你只需要实现一个解析函数和输出函数。
下面的例子定义一个64位整数标量但它的输入输出都是字符串。 (`Async-graphql`已经内置了对64位整数的支持正是采用字符串作为输入输出)
```rust
# extern crate async_graphql;
use async_graphql::*;
struct StringNumber(i64);
#[Scalar]
2020-04-28 02:32:26 +00:00
impl ScalarType for StringNumber {
fn parse(value: Value) -> InputValueResult<Self> {
if let Value::String(value) = &value {
// 解析整数
Ok(value.parse().map(StringNumber)?)
} else {
// 类型不匹配
2020-10-04 09:21:53 +00:00
Err(InputValueError::expected_type(value))
}
}
2020-05-26 15:27:50 +00:00
fn to_value(&self) -> Value {
Value::String(self.0.to_string())
}
}
```
2020-10-12 23:35:30 +00:00
## 使用`scalar!`宏定义标量
如果你的类型实现了`serde :: Serialize`和`serde :: Deserialize`,那么可以使用此宏更简单地定义标量。
```rust
# extern crate async_graphql;
# extern crate serde;
# use async_graphql::*;
# use serde::{Serialize, Deserialize};
# use std::collections::HashMap;
2020-10-12 23:35:30 +00:00
#[derive(Serialize, Deserialize)]
struct MyValue {
a: i32,
b: HashMap<String, i32>,
}
scalar!(MyValue);
// 重命名为`MV`.
// scalar!(MyValue, "MV");
// 重命名为`MV`并且添加描述.
// scalar!(MyValue, "MV", "This is my value");
```