|
' J) o* Y6 m) X) b: K<h2 id="系列导航">系列导航</h2>2 q) U0 O/ K4 [) M8 v( T9 W5 V7 a
<p><a href="https://www.cnblogs.com/code4nothing/p/graphql-net6-0.html">使用Hot Chocolate和.NET 6构建GraphQL应用文章索引</a></p>" J6 v; b) _; z$ Q! i
<h2 id="需求">需求</h2>
$ r2 S+ I! _5 a8 l8 E<p>在讨论完GraphQL中的查询需求后,这篇文章我们将演示如何实现GraphQL中的数据添加任务。</p>
L9 O/ T: l! D8 J+ i3 }<h2 id="思路">思路</h2>: q/ `: a% K0 d" l7 W! r2 x
<p>在GraphQL中,对数据进行查询使用<code>query</code>,而对于修改数据则需要使用<code>mutation</code>,包括新增和修改数据。Hot Chocolate在使用Mutation的逻辑上和使用Query的基本一致,但是需要根据需要定义用于创建或者更新的数据对象,所以我们直接进行实现。</p>
& H. `2 W/ y9 k<h2 id="实现">实现</h2>" {9 |$ B/ P1 i5 O# v! r5 [# n
<p>为了保持简单,我们先定义以下两个类型:</p>
- j. z, i6 D, I9 T6 a# ^7 r<pre><code class="language-c#">// 定义新增Post的参数- u5 N+ S: m: D% f
public record AddPostInput(string Title, string Author);
9 l. j- A }0 g+ l) p/ h" H/ t! z
& m/ |& d! t2 R$ a: Y4 P: H3 f5 @// 定义新增Post的返回对象" Z3 ^3 r1 m5 ]3 T$ u2 N7 r: P
public record AddPostPayload(Post Post);/ _" O+ m0 O( J4 W+ F$ V
</code></pre>
! F* U5 o) }+ l/ `) k( Z<p>新建<code>Mutation.cs</code>用来定义相关接口:</p>! {3 `" D. h: ]
<ul># k) g1 b% J- b3 T0 R' U
<li><code>Mutation.cs</code></li>
& h3 }7 G# c; H4 D</ul># {( m' ?9 _% ?4 U/ \& L9 h
<pre><code class="language-c#">namespace PostGraphi.Api.GraphQL;5 ?0 f- K9 u; f l* d
9 |" L3 ?+ d( _4 s4 Vpublic class Mutation* p; Y# h6 u" Z' X' R3 J
{; U+ |9 K2 |9 R5 ?
public async Task<AddPostPayload> AddPostAsync(AddPostInput input, [Service] IRepository<Post> repository)
: w% P3 K9 C( H$ i {" y- k8 z1 }9 x6 C; [
return new AddPostPayload(await repository.AddAsync(new Post- Z2 P) q' D0 Z8 [& z$ X' W# w
{
6 H/ o* L5 q4 |( `& y3 Q) d Title = input.Title,$ N" P" |8 P8 g; [9 ~) D
Author = input.Author
- p5 s" e# H4 r" } u( a: ?% M }));2 f/ @ c8 S Y4 k" Z& D0 M
}7 o6 y$ e9 C5 v' [% Q$ i8 g Y
}; {% m& @0 r9 _7 Y, c
3 y9 k" k4 L. t3 _7 J
</code></pre># H6 L: N: W2 p& ~5 r
<p>最后在注入服务的地方进行配置:</p>1 J( B/ r& B7 J! q+ w* t: v
<ul>3 f: Q8 L; l; w' U& j I0 h2 B! H
<li><code>ProgramExtensions.cs</code></li>- R( P: V/ Z: B3 A+ Z
</ul>1 R; Z* t4 e6 q2 m" Z
<pre><code class="language-c#">builder.Services
& T' r e) @, A .AddGraphQLServer()
3 U+ |5 X. f/ r/ s& P .SetPagingOptions(new PagingOptions
& x% ]( ], |$ V# y! \3 [ {; M" U8 v2 ]/ ?1 F% |0 E
MaxPageSize = 50,
/ p! p/ e+ i! u4 G) T% \/ h. { IncludeTotalCount = true
& Q% l7 z% I* y. @7 `' q4 w }): ?8 S( t; ?( ~: A9 T0 h) X: h
.AddFiltering()
_$ {& @5 H* x& A. M .AddProjections()* d9 i( c; {9 V3 K5 {" D
.AddSorting()8 o& e! y) x9 p* Q2 q
.AddQueryType<Query>(); z% H8 P I: i* s* K
.AddMutationType<Mutation>()$ X t3 M3 J( j, u! b1 ~! R
.AddMutationConventions(new MutationConventionOptions0 S& l, M- {: ]9 [7 P
{
! b3 A) l! A' C' Z. S ApplyToAllMutations = true,3 B6 \3 q `+ i: G, ?
InputArgumentName = "input",& T5 T$ J- H: f: g
InputTypeNamePattern = "{MutationName}Input",1 Y5 a4 q, Q. ^" ~! q- y! O
PayloadTypeNamePattern = "{MutationName}Payload",1 s$ w/ r1 R4 \/ i
PayloadErrorTypeNamePattern = "{MutationName}Error",5 |, A4 Y. M+ C: y9 b; Q; W4 n
PayloadErrorsFieldName = "errors"
* X* f5 K7 \9 J* ~ })
7 L4 z6 }* ?, o9 t# @/ e .AddType<PostType>();, c$ S; N/ Z3 ?) ? O& ~
</code></pre># Y0 j9 k( ?. z% p; \) K! C
<p>这样就实现了新增Post的需求,下面我们来验证一下。</p>
E, c) E4 ?1 a; K<h2 id="验证">验证</h2>$ p* a2 y7 |. m* v- n& q
<p>启动<code>Api</code>项目,调用接口:</p>
5 G9 ]' y% D& _( |<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104544617-1400586374.png" ></p>! a) a# O7 w: p$ G
<p>终端的日志输出如下:</p>
5 `& B! K2 M3 ^- ? x9 A9 ~0 W<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']4 m" Y1 [; r% m, t( \
INSERT INTO "Posts" ("Id", "Abstraction", "Author", "Content", "Created", "CreatedBy", "LastModified", "LastModifiedBy", "Link", "PublishedAt", "Title")
8 h2 W8 C3 t) g' r# e* L# ^VALUES (@p0, @p1, @p2, @p3, @p4, @p5, @p6, @p7, @p8, @p9, @p10);
6 o) }8 |. `0 F" b+ Y" T- \[10:45:15 INF] Executed endpoint 'Hot Chocolate GraphQL Pipeline'4 x2 R* ~$ x L( t; T4 G: a
</code></pre>
2 o1 B/ B2 ^( Q0 |, ]$ y6 f5 U) E<p>可以看到新建的Post已经存储到数据库中了,我们可以通过查询接口来获取详情:</p>* T; _8 {$ Y1 l" I2 }
<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104851825-1533915064.png" ></p>$ |2 J1 c, B9 j5 G
<h2 id="总结">总结</h2>+ q2 t) Q1 ~6 p. [3 M) M l4 K* W4 f
<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) M4 I/ o6 }8 u( O<p>在下一篇文章中,我们通过<code>Mutation</code>对已有数据进行更新。</p>
! j# n& q- Y, @
# R6 w& j5 Q8 w5 d# i+ y5 C |
|