Forem: tia

เรียก HTTP API อย่างสะดวกด้วย Refit

tia — Fri, 22 Jul 2022 10:26:29 +0000

Refit คืออะไร

Refit เป็น library ที่ทำให้เราสามารถเรียกใช้งาน HTTP API ได้ผ่าน interface ของ C# โดยที่เราไม่ต้องมาประกอบ URL/headers/body เองและ deserialize เองครับ

การใช้งาน

อันดับแรก ก็ติดตั้ง NuGet package ของ Refit ก่อนครับ เนื่องจากต้องการใช้แบบ HttpClientFactory เลยติดตั้งตัวนี้ตัวเดียวก็ได้

https://www.nuget.org/packages/Refit.HttpClientFactory/

เพื่อเป็นตัวอย่าง สมมติว่าผมจะเรียก Northwind API โดยมี API endpoint ที่จะเรียกอยู่ 3 ตัว คือ

GET /api/categories
GET /api/categories/{categoryId}
POST /api/categories

โดย response และ body ของ POST เป็น application/json มีรูปแบบประมาณนี้

{
    name: "เครื่องดื่ม",
    description: "ชา กาแฟ น้ำผลไม้ น้ำอัดลม เบียร์ ฯลฯ",
}

จาก API ที่กำหนดมา เราต้องแปลงมันเป็น interface ก่อน ซึ่งก็จะคล้ายคลึงกับการเขียน method ใน Controller ของ ASP.NET Core อยู่มาก รูปแบบก็จะทำนองนี้ คิดว่าน่าจะพอจับรูปแบบได้ครับ

public class Category 
{
    public string name { get; set; }
    public string description { get; set; }
}

public interface INorthwindApi
{
    [Get("/api/categories"]
    Task<List<Category>> GetCategoriesAsync();

    [Get("/api/categories/{categoryId}"]
    Task<Category> GetCategoryAsync(int categoryId);    

    [Post("/api/categories")]
    Task AddCategoryAsync(Category newCategory);
}

(การเขียน interface จะต้องใช้ method ที่ return Task หรือ Task<T> เสมอครับ เพราะ Refit ไม่รองรับการเรียก API แบบ synchoronous)

ถ้ามองจาก interface นี้ เราจะเห็นว่าถ้าเรามี interface นี้เราก็สามารถเรียกมันได้ตรง ๆ เลย และตัว Refit นี่เองก็จะเป็นตัวที่จัดการให้เราครับ ในที่นี้ จะใช้วิธีเรียกใช้โดยผ่าน DI ครับ ดังนั้นจึงต้องมีการ register service ก่อน โดยในส่วน ConfigureServices ใน Startup class ให้เพิ่มดังนี้ครับ

services.AddRefitClient<INorthwindApi>()
        .ConfigureHttpClient(
            c => c.BaseAddress = new Uri("https://northwind.now.sh/")
        );

แค่นี้เราก็จะมี service INorthwindApi ที่สามารถ inject ไปใช้ใน Controller ได้แล้วครับ เช่นเราสามารถสร้าง Controller ประมาณนี้ได้

[Route("api/categories"]
public class NorthwindCategoryController : ControllerBase
{
    private readonly INorthwindApi _api;
    public NorthwindCategoryController(INorthwindApi api) 
    {
        _api = api;
    }

    [HttpGet]
    public Task<List<Category>> GetCategoriesAsync() 
        => _api.GetCategoriesAsync();

    [HttpGet("{categoryId}"]
    Task<Category> GetCategoryAsync(int categoryId) 
        => _api.GetCategoryAsync();

    [HttpPost]
    Task AddCategoryAsync(Category newCategory) 
        => _api.AddCategoryAsync(newCategory);
}

จะเห็นว่าการใช้ Refit เราก็ไม่ต้องยุ่งยากกับการใช้ HttpClient รวมถึงไม่ต้องจัดการเรื่องการ serialization/deserialization อะไรเลย

การดึงค่าจาก Dictionary แบบเช็คค่าแล้วจบในบรรทัดเดียว

tia — Thu, 03 Oct 2019 18:37:38 +0000

วันนี้จะมาพูดถึงการดึงค่าจาก Dictionary ที่ดูเหมือนจะไม่มีอะไร แต่ไม่ค่อยเห็นการใช้ในแบบที่ควรจะเป็นสักเท่าไหร่ครับ

การใช้ Dictionary ปกติแล้ว มักจะต้องมีการเช็คก่อนว่ามี key อยู่หรือไม่ เนื่องจากการเรียกจาก key ที่ไม่มีอยู่จะทำให้เกิด exception ดังนั้นจึงมักจะเห็น code แบบนี้เป็นปกติ

  public string FindX_Naive(Dictionary<string, string> dic) 
  {
    if (dic.ContainsKey("X")) return dic["X"];
    else return null;    
  }

แต่บางท่านก็อาจจะเห็นแล้วว่า ปัญหาของ code นี้คือ มันต้องไปวิ่งหา 2 ครั้ง คือ ที่ dic.ContainsKey("X") รอบนึง แล้วก็ที่ dic["X"] อีกรอบนึง แถมยังมี "X" ในโค้ดสองที่อีกต่างหาก

ซึ่งความจริงแล้ว Dictionary ของ .NET มี method TryGetValue() ให้ใช้อยู่แล้ว ซึ่งถ้าเปลี่ยนไปใช้แบบนั้น ก็อาจจะเขียนออกมาได้แบบนี้

  public string FindX_Try(Dictionary<string, string> dic) 
  {
    string s;
    if (dic.TryGetValue("X", out s)) return s;
    else return null;
  }

คราวนี้ เราก็มี "X" ที่เดียว และวิ่งหารอบเดียวแล้วคือตอนที่เรียก TryGetValue แต่ปัญหาคือ code ดูรกรุงรังมาก โดยเฉพาะตัวแปร s ที่ประกาศมาก็ไม่ได้ใช้อะไรมาก แต่โชคดีที่ C# 7 ได้เพิ่มวิธีการประกาศตัวแปร out ให้ทำได้ตรงที่เรียกใช้เลย ดังนั้นเราก็จะสามารถเขียนให้กระชับกว่าเดิมได้

  public string FindX_Try_OutVar(Dictionary<string, string> dic) 
  {
    if (dic.TryGetValue("X", out var s)) return s;
    else return null;
  }

แต่เขียนให้สั้นกว่านี้ก็ยังได้ โดยใช้ conditional operator และ expresion bodied method

  public string FindX_Final(Dictionary<string, string> dic) 
    => dic.TryGetValue("X", out var s) ? s : null;

ซึ่งจะเห็นว่าเขียนสั้นพอ ๆ กับแบบแรก แต่ถูกต้องในแบบที่ควรจะใช้มากกว่า

สรุปคือ ถึงแม้ว่าการเขียนแบบตัวอย่างแรกสุดจะดูเข้าใจง่าย แต่ก็เป็นการสิ้นเปลืองในการที่จะต้องวิ่งหาใน Dictionary สองรอบ ซึ่งก่อนหน้านี้ก็พอมีข้ออ้างได้ว่า code ดูง่ายกว่าเพราะการเขียนแบบใช้ out ก็จะดูเยิ่นเย้อ แต่ตั้งแต่ C# 7 เป็นต้นมา ก็มี feature พอที่จะเขียนรูปแบบดังกล่าวให้อ่านง่ายและได้ประสิทธิภาพดีกว่าแล้วครับ