|
|
. ?' v, i8 v+ t
<h2 id="系列导航">系列导航</h2>
" W% Y! m) M4 l/ {) W n) S<p><a href="https://www.cnblogs.com/code4nothing/p/graphql-net6-0.html">使用Hot Chocolate和.NET 6构建GraphQL应用文章索引</a></p>
6 g k" [$ D# Z- D$ O$ K; z, M<h2 id="需求">需求</h2>
1 U) i, T. S) p! Q: d# v<p>在讨论完GraphQL中的查询需求后,这篇文章我们将演示如何实现GraphQL中的数据添加任务。</p>
$ k/ c, [5 Z9 M4 l<h2 id="思路">思路</h2>0 c$ i q2 m: \# I0 N, y2 k3 ?
<p>在GraphQL中,对数据进行查询使用<code>query</code>,而对于修改数据则需要使用<code>mutation</code>,包括新增和修改数据。Hot Chocolate在使用Mutation的逻辑上和使用Query的基本一致,但是需要根据需要定义用于创建或者更新的数据对象,所以我们直接进行实现。</p>
2 n! g" e! _( S& I a& e+ B<h2 id="实现">实现</h2>8 m) p. |8 |7 K( J, a( l
<p>为了保持简单,我们先定义以下两个类型:</p>; R i' O! C! {0 _+ M" r1 s6 H/ t
<pre><code class="language-c#">// 定义新增Post的参数4 D" R7 T0 F6 e, {( F( q
public record AddPostInput(string Title, string Author);
$ \; ?6 E2 X$ c3 \4 q6 U6 z; ]; S$ T/ Y6 J ^0 j* s
// 定义新增Post的返回对象+ d( b- Z* j9 F
public record AddPostPayload(Post Post);
4 ~$ r; R. c9 z; S! {</code></pre>1 z1 [$ l3 a& i/ ^$ n& s7 d
<p>新建<code>Mutation.cs</code>用来定义相关接口:</p>
) j6 e, w8 f/ x, }8 r! Z<ul>. F0 W+ O$ }2 _0 A9 S
<li><code>Mutation.cs</code></li>+ |% n2 N" l0 l; l5 {+ i8 B
</ul>! a2 ~$ ?; I1 G+ T: V9 p
<pre><code class="language-c#">namespace PostGraphi.Api.GraphQL;% ^6 |2 x" s! b+ B* P2 Z* f1 Z, g
/ c5 b4 ^( F/ `- A9 J3 u( c. M
public class Mutation$ s6 G, v8 k# f) e
{+ o% H! g& I. _: q* F9 @4 T
public async Task<AddPostPayload> AddPostAsync(AddPostInput input, [Service] IRepository<Post> repository)
& y1 `9 M$ j& H/ J6 q {
. i, T" w7 Z$ h return new AddPostPayload(await repository.AddAsync(new Post+ t0 f2 t" g& K
{1 S' }% { E* W$ o N$ D+ U
Title = input.Title,
7 }4 C0 V( n+ ? k6 k" m Author = input.Author
2 c2 w" F1 W" d }));
. b$ x. k( _! |" r }
$ d# b: |/ P4 A1 M% L}- ~1 `: k9 Y6 Y& @/ B" `" A( j" q
5 _6 G! Y- i' Q8 {0 }8 M/ ]: u. M</code></pre>
/ S9 o& |8 U, s6 h<p>最后在注入服务的地方进行配置:</p>' z3 t- Q, k4 i
<ul> c! i" i- a$ P' E: L" {
<li><code>ProgramExtensions.cs</code></li>
) v; O5 H- f+ Q3 |9 u6 V3 a3 Y0 h8 Q</ul>! P5 ~' z6 l! j) G: T. T
<pre><code class="language-c#">builder.Services
9 F$ q4 D+ S! N* @0 V' q) c" n0 g .AddGraphQLServer()" F, O0 U+ _ f
.SetPagingOptions(new PagingOptions
. i3 R9 v$ V1 Z+ E% e) d {4 n& y, H# T/ b {1 h
MaxPageSize = 50,
5 Z) o9 r- e0 G4 B# f IncludeTotalCount = true
: i* y; L$ @: x* ^* M# {$ l })4 d! _# F7 ]$ C3 r
.AddFiltering()
3 \) ]0 [$ r- R+ o2 ]/ j h# V3 [ .AddProjections()
" _$ B$ {7 F+ t4 a) S5 A .AddSorting()6 }9 R" j& C- I6 N( B
.AddQueryType<Query>()
4 Q% L, G/ z" H! e4 Z( {$ \7 t .AddMutationType<Mutation>()8 Q" O3 ^3 d; n4 K- V9 ^" q; \
.AddMutationConventions(new MutationConventionOptions
) I% `) e. H" x. M6 j4 u- `. O {# `* E+ z( B4 I7 F
ApplyToAllMutations = true,4 R( u. x5 N9 O, T' V1 |3 N0 a
InputArgumentName = "input",
. q% J K1 v' z; A# V* q InputTypeNamePattern = "{MutationName}Input",
" d, g: J% Q2 ~7 l5 B PayloadTypeNamePattern = "{MutationName}Payload",3 V/ W: B2 ]! @2 \8 q) @
PayloadErrorTypeNamePattern = "{MutationName}Error",
7 G# }( F' R3 u$ Y3 { I: y1 o PayloadErrorsFieldName = "errors"- |( c! ^3 h# P1 f: t3 O; T2 J e
})
( c& q+ v$ h6 [: i5 A' V( ? .AddType<PostType>(); U, Z3 `" K ]/ S( [5 c1 }
</code></pre>$ h+ N% D3 m( b3 X/ ~0 j* d: x
<p>这样就实现了新增Post的需求,下面我们来验证一下。</p>* n' I6 h. ~1 i: M8 g [0 o2 l# A
<h2 id="验证">验证</h2>% j: d1 P1 M0 v {. U/ P
<p>启动<code>Api</code>项目,调用接口:</p>, O# ]7 z: k& `. y8 I0 c
<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104544617-1400586374.png" ></p> p' U- h/ _$ a
<p>终端的日志输出如下:</p>
' K+ ^% u# D7 r! G; a, Y<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']
. P$ W/ m# f4 A; }0 zINSERT INTO "Posts" ("Id", "Abstraction", "Author", "Content", "Created", "CreatedBy", "LastModified", "LastModifiedBy", "Link", "PublishedAt", "Title")
/ ^: {* v0 g: M! b' iVALUES (@p0, @p1, @p2, @p3, @p4, @p5, @p6, @p7, @p8, @p9, @p10);0 _3 a& X' U, Z$ T* ~+ k2 Q
[10:45:15 INF] Executed endpoint 'Hot Chocolate GraphQL Pipeline'
5 q1 q; l- q* O/ L</code></pre>
0 ~6 d* e7 F* P+ s/ \3 V# p, @# {<p>可以看到新建的Post已经存储到数据库中了,我们可以通过查询接口来获取详情:</p>8 i/ s1 F- T6 C( w( Y
<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104851825-1533915064.png" ></p>
7 W% C; |: L. a' ]* t1 m8 v. z B<h2 id="总结">总结</h2>
" g" ?/ k& ~) d: p4 r<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> Z) z, |1 l" R# c. s4 |8 _
<p>在下一篇文章中,我们通过<code>Mutation</code>对已有数据进行更新。</p>
! X) W8 g5 P% n4 |0 g' w, T3 b* G- S' P6 u9 i# M B! B
|
|