|
|
; H1 R8 d5 I b6 m
<h2 id="系列导航">系列导航</h2>
; I0 z F/ a, L% [<p><a href="https://www.cnblogs.com/code4nothing/p/graphql-net6-0.html">使用Hot Chocolate和.NET 6构建GraphQL应用文章索引</a></p>8 D2 l0 e4 h% t7 e' Y/ g* h7 z
<h2 id="需求">需求</h2>0 u( m7 h. a* ^& r, i# b3 }
<p>在讨论完GraphQL中的查询需求后,这篇文章我们将演示如何实现GraphQL中的数据添加任务。</p>
/ b. z3 Q @3 K) ~<h2 id="思路">思路</h2>
1 u7 F) b6 _* Q: Q: E T4 m<p>在GraphQL中,对数据进行查询使用<code>query</code>,而对于修改数据则需要使用<code>mutation</code>,包括新增和修改数据。Hot Chocolate在使用Mutation的逻辑上和使用Query的基本一致,但是需要根据需要定义用于创建或者更新的数据对象,所以我们直接进行实现。</p>
6 F) A6 {" i/ c$ i. p# ^5 y8 m<h2 id="实现">实现</h2>( i6 R4 w2 L$ i6 y: M7 w/ I
<p>为了保持简单,我们先定义以下两个类型:</p>
% H$ N8 G) Y. p# U, z<pre><code class="language-c#">// 定义新增Post的参数% X W8 ^9 Z9 B" N# Z
public record AddPostInput(string Title, string Author);
9 }" K0 N6 c- \' }* g* _' a. G7 j K, Z$ ^* H6 y
// 定义新增Post的返回对象
+ u. _) `9 r- \% b5 L t' ]public record AddPostPayload(Post Post);
9 d; `' d0 l/ g( M</code></pre> x; ]7 ]1 r$ \$ `7 X. n
<p>新建<code>Mutation.cs</code>用来定义相关接口:</p>0 n) ?+ @ h: e: p
<ul>/ g2 _3 j; d# E, t( I# l7 k
<li><code>Mutation.cs</code></li>
/ W, o/ D& b) t% B8 i! P</ul>3 D5 M& u, Q, E5 W
<pre><code class="language-c#">namespace PostGraphi.Api.GraphQL;
6 L7 R: q+ G$ t+ @3 z
4 O* D0 L+ v9 Q) h$ H8 Q3 l+ c' g) ]public class Mutation, g7 d5 t; N* `1 F, f7 P2 {
{
0 U& G) {) E( I% Y$ u public async Task<AddPostPayload> AddPostAsync(AddPostInput input, [Service] IRepository<Post> repository)
3 N) D% @4 E, Y: _! A7 ?: d3 X {
. L2 Y) f4 u7 \* z0 B) a+ h! e8 L return new AddPostPayload(await repository.AddAsync(new Post
. _$ f5 P) h1 i8 |' U( `4 ] {
( ~2 u" f" H) \. c5 v Title = input.Title,
1 W- v6 D) A6 T' }, }: N; U' S% d Author = input.Author% D6 M9 ^% a1 ~+ q& W# V- l
})); t, n; t" m `$ N) }. |
}
' ? m. J/ z' P* w- B5 H; |* u} p) Y# b, ?' y# R
/ E3 H. o8 s8 Z \4 q
</code></pre>
# Z4 _; Y# i, c& @' R<p>最后在注入服务的地方进行配置:</p>9 t$ ~( g. Z+ X) D( ~/ C
<ul>
7 ~+ |* @, `! f E<li><code>ProgramExtensions.cs</code></li>; h; L9 v$ \* J. j7 O! W& X9 C3 R9 j
</ul>' ]( J( v1 R1 w6 {% A. w4 B
<pre><code class="language-c#">builder.Services4 i5 j) Q* h$ J" F; G1 D1 H; O
.AddGraphQLServer()4 @3 Y- `8 A) o7 m) x, @1 C" w' A
.SetPagingOptions(new PagingOptions. }0 z# s( t9 a; c* B
{$ y/ n9 ~4 s& c/ @. V
MaxPageSize = 50,8 J8 K% K, `: f! t
IncludeTotalCount = true1 `$ u5 j1 K* _# ~' _6 ?$ k& |
})( v" V1 N8 [ q& u/ L
.AddFiltering()) q# Q2 A4 }, L, c$ I5 T9 G
.AddProjections()2 g- U4 g! o5 |- x6 p& z- e" f
.AddSorting()
- C8 n; K6 j" J# e+ i' I8 y .AddQueryType<Query>() |* `' p6 o1 {) ~
.AddMutationType<Mutation>()$ u; R, ]5 F9 v3 W S9 u
.AddMutationConventions(new MutationConventionOptions
, B- \# E' |0 `7 G6 O! K/ \ {' z. W, s8 d8 |, v/ X5 P% l
ApplyToAllMutations = true,
& h- ~ j8 a+ a InputArgumentName = "input",; w9 c# t2 ], p# t! d$ z7 E
InputTypeNamePattern = "{MutationName}Input",* Y9 x' l& `% s! P! R. w) @
PayloadTypeNamePattern = "{MutationName}Payload",: Q8 f9 J- x! ]4 e0 d4 M
PayloadErrorTypeNamePattern = "{MutationName}Error",/ J+ x8 K" I l' k& V- e
PayloadErrorsFieldName = "errors"
3 n8 w$ {2 {1 U/ N" F$ k })1 b$ B# p2 R2 j! {- T5 _9 x
.AddType<PostType>();
. F! u! {1 J J$ Q</code></pre>
( L( H% J! b. O; j" O. U2 V<p>这样就实现了新增Post的需求,下面我们来验证一下。</p>2 J) b9 q7 N/ n9 C# u
<h2 id="验证">验证</h2>
5 Q, g. K, ]4 N, t/ L' @<p>启动<code>Api</code>项目,调用接口:</p>
; V4 f7 d* w8 ~9 P! I; F! `<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104544617-1400586374.png" ></p>
x0 K! v* q6 P. v- ~" p+ \+ p0 [<p>终端的日志输出如下:</p>
9 L5 a* H+ x# D<pre><code class="language-bash">[10:45:15 INF] Executed DbCommand (1ms) [Parameters=[@p0='?' (DbType = Guid), @p1='?', @p2='?' (Size = 13), @p3='?', @p4='?' (DbType = DateTime), @p5='?', @p6='?' (DbType = DateTime), @p7='?', @p8='?', @p9='?' (DbType = DateTime), @p10='?' (Size = 30)], CommandType='Text', CommandTimeout='30']6 I# D$ Q* v. J4 h* j, a4 z* J
INSERT INTO "Posts" ("Id", "Abstraction", "Author", "Content", "Created", "CreatedBy", "LastModified", "LastModifiedBy", "Link", "PublishedAt", "Title")
7 Q* N( e3 K: K5 l7 q4 k7 ~VALUES (@p0, @p1, @p2, @p3, @p4, @p5, @p6, @p7, @p8, @p9, @p10);
' m- _& \- {3 M. H: s[10:45:15 INF] Executed endpoint 'Hot Chocolate GraphQL Pipeline'1 b; f* z I$ f, |' n
</code></pre>) V, W' I; V9 A& |" S2 m7 X1 U) F4 s
<p>可以看到新建的Post已经存储到数据库中了,我们可以通过查询接口来获取详情:</p>/ e7 s* _ B& b( D3 j4 V
<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104851825-1533915064.png" ></p>9 l. }# w! a6 z4 P: ?" x0 }% q
<h2 id="总结">总结</h2>
r/ _) H% w1 ?<p>在本文中我们实现了简单的新增Post操作,这里还有一些涉及到错误处理的内容,我没有在文章中演示,可以参考官方文档 <a href="https://chillicream.com/docs/hotchocolate/defining-a-schema/mutations/#errors">Errors</a>,在自定义异常对象后,有三种方式可以进行错误处理:直接返回异常;使用异常工厂方法;使用构造函数。甚至可以在<code>AggregateExceptions</code>中一次性返回多个异常。基本思路都是通过添加属性<code>[Error(typeof(SomeUserDefinedException))]</code>来实现的。</p>$ e( C: K! t/ A- z: P6 A# v0 l8 t* K {
<p>在下一篇文章中,我们通过<code>Mutation</code>对已有数据进行更新。</p>
! x+ J( w6 g# C1 G& F4 x
2 S q7 A+ i4 u! M# U( x |
|