|
|
6 J. F j$ _1 F' G' J8 x0 b- Z
<h2 id="系列导航">系列导航</h2>' `0 j5 X* E. V
<p><a href="https://www.cnblogs.com/code4nothing/p/graphql-net6-0.html">使用Hot Chocolate和.NET 6构建GraphQL应用文章索引</a></p>
* K; B( R) M& c+ ^<h2 id="需求">需求</h2>- L% R+ _$ ?% p
<p>在讨论完GraphQL中的查询需求后,这篇文章我们将演示如何实现GraphQL中的数据添加任务。</p>3 w @ @. E1 p. f1 |- p* O
<h2 id="思路">思路</h2>
; N' Z2 F. S& g; n# a- ^: \<p>在GraphQL中,对数据进行查询使用<code>query</code>,而对于修改数据则需要使用<code>mutation</code>,包括新增和修改数据。Hot Chocolate在使用Mutation的逻辑上和使用Query的基本一致,但是需要根据需要定义用于创建或者更新的数据对象,所以我们直接进行实现。</p>/ x6 ? x& @# H- }+ u5 A1 G4 ~$ G$ d
<h2 id="实现">实现</h2>7 d J8 u: b2 w. _" `
<p>为了保持简单,我们先定义以下两个类型:</p>$ o, \0 E$ \; T) W* N+ k
<pre><code class="language-c#">// 定义新增Post的参数9 Q: d D. M! m4 @; i7 n1 Z" R, ]
public record AddPostInput(string Title, string Author);
0 p6 k8 Z5 z+ y5 l+ ] `! R+ m7 V* c7 a
// 定义新增Post的返回对象 ^, S0 Y6 l8 H
public record AddPostPayload(Post Post);
# e, q) y1 w% D$ a2 r+ r1 _+ c</code></pre>
5 f( x8 X' D) k' F. f7 o2 b( j<p>新建<code>Mutation.cs</code>用来定义相关接口:</p>
6 h& b/ }5 I9 f) ~. X$ a4 h<ul>
# k. C% K* K% a- M- {& c: F<li><code>Mutation.cs</code></li>
! q% g1 O$ l+ i0 M</ul>
$ b) s6 Q5 I7 c" O. {; @7 d! |<pre><code class="language-c#">namespace PostGraphi.Api.GraphQL;+ t( j3 D' F" P+ Z M1 H8 J; O
# C S6 V. C' M7 b. Q* A
public class Mutation7 j1 P# O' z' p$ d5 _- U
{% H3 X$ L4 s4 z* A! G
public async Task<AddPostPayload> AddPostAsync(AddPostInput input, [Service] IRepository<Post> repository)
1 o" J7 g! R- l: M, b I9 { {6 Q: ]: \7 \+ n5 Q( t4 j' r
return new AddPostPayload(await repository.AddAsync(new Post( q/ F/ v: e; n8 r. z, i( G
{
0 F& I8 b4 ]7 C- t. b Title = input.Title,
; |2 v9 b9 w5 J" V7 U8 Z4 N Author = input.Author: J% Z& R2 T" Z" c
}));
! E6 Q: p/ }. ~6 x& T }0 ]1 l9 [ V% U% ?
}
6 \, t! w- _+ J1 Z0 \ F1 b) T2 s" x' e8 Z+ z! S
</code></pre>
' }" p- T. o. ?( U( A) ^<p>最后在注入服务的地方进行配置:</p>7 `7 S0 z2 u) e% u
<ul>
( Q3 n) f A1 ]% G' d+ {- t/ t<li><code>ProgramExtensions.cs</code></li>
: g5 m! o' T3 E</ul>
6 o0 U2 w; Z/ K# m+ d! N/ ^* ~$ G<pre><code class="language-c#">builder.Services0 {5 p6 E: |& V4 Y# H
.AddGraphQLServer()
/ i: k6 b% \( J' u' T* Y) A' F .SetPagingOptions(new PagingOptions8 } V& L/ i+ T0 [2 e2 \
{( Y9 X" l! z$ J! m7 w \
MaxPageSize = 50,( d( ^& J# P) C% ], m5 V; B
IncludeTotalCount = true! s; ]' y7 ?8 Z1 ~6 [) a
})( q2 Y! a f* c- T8 o/ a$ A5 {
.AddFiltering()7 r" Z3 |3 P- N
.AddProjections()$ p5 l8 r( M' k% M, @7 O
.AddSorting()
. N, |1 |: J8 f4 c/ M1 k0 u .AddQueryType<Query>()5 \8 t. Y8 B. m$ `" ?( d" h4 y) H
.AddMutationType<Mutation>()0 o, O4 W: m n5 S; `
.AddMutationConventions(new MutationConventionOptions; w3 K+ l2 l1 b2 M2 j
{/ l B o6 H4 B0 L3 ~) O$ Y0 |
ApplyToAllMutations = true,
! Y* l" M6 w. R- o InputArgumentName = "input",! y: P, f; O2 v
InputTypeNamePattern = "{MutationName}Input",5 R/ O; H! t) c+ X( }
PayloadTypeNamePattern = "{MutationName}Payload",3 i& A; x% P/ w
PayloadErrorTypeNamePattern = "{MutationName}Error",
0 }1 Q! g+ ^! }, l- M; k PayloadErrorsFieldName = "errors"
3 ^ U: u) z6 l M- r; s })
! f3 f& b6 I+ v8 {2 C .AddType<PostType>();
9 \4 o0 ^8 R7 T' K4 ^/ o; i5 u</code></pre>
9 J3 G: ~6 m/ Q# Y<p>这样就实现了新增Post的需求,下面我们来验证一下。</p>6 k1 ~/ B$ Z0 F& ~) w5 Z9 A
<h2 id="验证">验证</h2>& u, P4 Q( R+ r6 T* n0 }- @
<p>启动<code>Api</code>项目,调用接口:</p>
! R1 ?0 s" X" I/ q+ I5 v<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104544617-1400586374.png" ></p> h3 s7 e+ Y- H) H, ]% e1 d9 }) G
<p>终端的日志输出如下:</p>& l2 G/ Z3 d. T: l# v' B9 U+ Q* s
<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']
. h9 e5 `8 q+ S/ J- ^9 t/ [* F' WINSERT INTO "Posts" ("Id", "Abstraction", "Author", "Content", "Created", "CreatedBy", "LastModified", "LastModifiedBy", "Link", "PublishedAt", "Title"). l" o% t" m7 |1 ~' K7 {3 w! q0 l9 ?9 N
VALUES (@p0, @p1, @p2, @p3, @p4, @p5, @p6, @p7, @p8, @p9, @p10);
( f+ h b0 m8 B$ W9 Q) ^, I4 D[10:45:15 INF] Executed endpoint 'Hot Chocolate GraphQL Pipeline'
0 [7 @7 d, v! T+ d' P) g* i0 v</code></pre>
4 [+ c A: i# X* j9 C% [* b W# p1 `<p>可以看到新建的Post已经存储到数据库中了,我们可以通过查询接口来获取详情:</p>
d1 v* i: K) z% x% S2 a( c% l<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104851825-1533915064.png" ></p>
8 E; f2 g) B9 K3 Z<h2 id="总结">总结</h2>3 B0 I! |9 l) o# L& s1 [" k% 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>% C& ]1 h' K6 g4 p7 |
<p>在下一篇文章中,我们通过<code>Mutation</code>对已有数据进行更新。</p>9 ]2 s; I; X( y+ k6 Q" F6 H
! d% Y/ n& s* |3 Q3 s |
|