|
9 I& e2 L* q. N# B<h2 id="系列导航">系列导航</h2>
3 @% p/ q O4 ]8 |. g$ M- y& Q<p><a href="https://www.cnblogs.com/code4nothing/p/graphql-net6-0.html">使用Hot Chocolate和.NET 6构建GraphQL应用文章索引</a></p>: h! V4 r5 f3 l. }
<h2 id="需求">需求</h2>+ b- b8 X" k/ y( Y
<p>在讨论完GraphQL中的查询需求后,这篇文章我们将演示如何实现GraphQL中的数据添加任务。</p>
3 y0 J5 ?" W: c0 ]9 ]<h2 id="思路">思路</h2>9 I" c+ K; }' V6 D5 l; b
<p>在GraphQL中,对数据进行查询使用<code>query</code>,而对于修改数据则需要使用<code>mutation</code>,包括新增和修改数据。Hot Chocolate在使用Mutation的逻辑上和使用Query的基本一致,但是需要根据需要定义用于创建或者更新的数据对象,所以我们直接进行实现。</p>7 c0 B8 v( D' G* `2 b6 J
<h2 id="实现">实现</h2>1 U: e( x7 K0 S" z
<p>为了保持简单,我们先定义以下两个类型:</p>
0 Q8 [, J" o2 I<pre><code class="language-c#">// 定义新增Post的参数
& Z: a- ]6 K. N/ W; p$ ypublic record AddPostInput(string Title, string Author);
& t$ p; H, _2 \9 M+ L! `& a8 _4 U6 i" b' Z# H
// 定义新增Post的返回对象
- J) b) R4 F) b; e" y3 |- ]public record AddPostPayload(Post Post);/ q7 L- X$ q0 {2 c3 X- n" X
</code></pre>8 N. ]8 V, u$ `) w; B; o- p
<p>新建<code>Mutation.cs</code>用来定义相关接口:</p>/ d+ o" a: B7 S9 t8 P; R# C
<ul>* i$ u- C* D1 q" O& ~3 H6 Z
<li><code>Mutation.cs</code></li>
9 @, c. q8 f' B</ul>% Q4 _0 y/ Y3 J/ X7 J( D( e
<pre><code class="language-c#">namespace PostGraphi.Api.GraphQL;) _) C7 G, D8 K$ \
2 _; [1 ~7 w6 a5 ~) M- Upublic class Mutation
8 M, G3 n+ h2 O' ?, \9 d2 [9 w{% [1 d0 V& a$ E5 x+ m" p: b3 O5 z' b( Z
public async Task<AddPostPayload> AddPostAsync(AddPostInput input, [Service] IRepository<Post> repository)* O) P; N8 K% ]6 U$ d# k
{1 u) I. R+ i' _! V2 x2 e/ J, w1 G V
return new AddPostPayload(await repository.AddAsync(new Post
8 k7 T# n/ v5 r3 o6 k3 b {
; Q+ a* f. n# Z! e. q Title = input.Title,
9 T/ T$ [& G2 @6 ~ Author = input.Author
' {" S3 w6 H5 N q* o }));. }6 ~7 Z) S( \! S# n0 r; N
}# w& y6 K" X3 d9 Q+ @' p
}
% v6 I t. t1 f! @3 w$ z; b% F4 g* |' _4 }. ?* h& C, W! t
</code></pre>
q7 m- D1 ]4 e+ j; \2 {<p>最后在注入服务的地方进行配置:</p>
L3 v: ~. X1 w5 L3 S<ul>! \' E2 _! @) P+ a& V
<li><code>ProgramExtensions.cs</code></li> e% g4 I5 h- N! ]6 q( q
</ul>
' J# o, f. u* v( y<pre><code class="language-c#">builder.Services
( E% H# _6 u9 o: ? .AddGraphQLServer()! e6 b0 _" ]8 r [1 C
.SetPagingOptions(new PagingOptions- F$ |( X* ]0 x: l% w9 Y
{
" v( h. i/ z% L V7 x3 ? MaxPageSize = 50,. x1 E6 u: J$ \6 x: a' |9 W
IncludeTotalCount = true
& M! @, c" m$ I3 _% o& G; n })
( P z1 u4 |2 b4 }6 X9 T' U4 R .AddFiltering()( L; b: _5 c5 l
.AddProjections(): N2 X6 \0 ]3 ~
.AddSorting()
- n) j) T8 {& l( [: ?2 ` .AddQueryType<Query>()
$ N: b l3 |/ N .AddMutationType<Mutation>()
! J. ]. O6 g2 T( c7 } .AddMutationConventions(new MutationConventionOptions
+ k2 i9 Q1 t: S1 I; X {9 V, N. a+ y9 `/ B& ]6 K
ApplyToAllMutations = true,( c5 ]' ` b" x3 c! Q
InputArgumentName = "input",
% M7 l& Q+ ]6 r: `7 m InputTypeNamePattern = "{MutationName}Input",) x; B# ?3 Z2 z2 @5 T `- M6 e
PayloadTypeNamePattern = "{MutationName}Payload",
7 p k$ E. `. F# s PayloadErrorTypeNamePattern = "{MutationName}Error",% o' H1 t+ o; p
PayloadErrorsFieldName = "errors"% F u% |: g& H# b
})
' T6 a. \ K/ [+ k" A .AddType<PostType>();
$ d$ S' T& c% {. I</code></pre>0 \/ }9 `. q6 J! R8 C4 |, ~
<p>这样就实现了新增Post的需求,下面我们来验证一下。</p>
9 Y! P. P& ]+ I. A* Y2 r5 x5 A1 c<h2 id="验证">验证</h2>( A+ U/ _6 ^) H+ |* f6 Q( l
<p>启动<code>Api</code>项目,调用接口:</p>
& S( q* I5 }4 N) R+ x+ }<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104544617-1400586374.png" ></p>
3 w; B) g" c K$ _* }6 U9 ?<p>终端的日志输出如下:</p>
! O$ {8 `, {9 X<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']' G" k6 N# B, j! `3 L9 E9 G1 w
INSERT INTO "Posts" ("Id", "Abstraction", "Author", "Content", "Created", "CreatedBy", "LastModified", "LastModifiedBy", "Link", "PublishedAt", "Title")
: n+ a# b g4 u# f) N3 CVALUES (@p0, @p1, @p2, @p3, @p4, @p5, @p6, @p7, @p8, @p9, @p10);
/ N, g0 E. E. j/ x+ L/ |8 N" {[10:45:15 INF] Executed endpoint 'Hot Chocolate GraphQL Pipeline'
( D* s' ?% g3 c0 Y</code></pre>
! ~' z; `3 G+ t3 \<p>可以看到新建的Post已经存储到数据库中了,我们可以通过查询接口来获取详情:</p>
0 Y* B. Q8 K) I& q. o<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104851825-1533915064.png" ></p>0 N) V. T4 r$ Y! h
<h2 id="总结">总结</h2>, J, a4 _, D- O
<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>
; f$ _# r V7 ^$ d9 F0 D! U<p>在下一篇文章中,我们通过<code>Mutation</code>对已有数据进行更新。</p>
3 Z8 `/ X" J: |2 O) h0 N; A. I8 [
" v w Q1 R6 S; j( J9 Z |
|