@jsakamoto

先日、北海道 定山渓温泉で開催したプログラマ向け合宿イベント Code 2014 in 定山渓温泉で用意した、C# + Entity Framework + ASP.NET WebAPI で記述したサンプルの Web API サーバー。

これを "C# の軽量構文" としての F# として、F# で書き直したらどの程度シンプルになるのか、実証してみたくてやってみた。

C# の API コントローラ(下記)が、

using SampleAPIServer.Models;

using System.Collections.Generic;

using System.Web.Http;

using System.Web.Http.Cors;



namespace SampleAPIServer.Controllers

{

  [EnableCors("*", "*", "*")]

  public class BookmarksController : ApiController

  {

    public SampleAPIDBContext DB { get; set; }



    public BookmarksController()

    {

      this.DB = new SampleAPIDBContext();

    }



    public IEnumerable Get()

    {

      return this.DB.Bookmarks;

    }



    public Bookmark Get(int id)

    {

      return this.DB.Bookmarks.Find(id);

    }



    public void Post([FromBody]Bookmark value)

    {

      this.DB.Bookmarks.Add(value);

      this.DB.SaveChanges();

    }



    public void Put(int id, [FromBody]Bookmark value)

    {

      var bookmark = Get(id);

      bookmark.Title = value.Title;

      bookmark.URL = value.URL;

      bookmark.Rating = value.Rating;

      this.DB.SaveChanges();

    }



    public void Delete(int id)

    {

      var bookmark = Get(id);

      this.DB.Bookmarks.Remove(bookmark);

      this.DB.SaveChanges();

    }

  }

}

F# ではこうなる。

namespace SampleAPIServer.Controller

open System.Linq

open System.Web.Http.Cors

open SampleAPIServer.Models



[<EnableCors("*", "*", "*")>]

type BookmarksController() = 

  inherit System.Web.Http.ApiController()

  

  let db = new SampleAPIDBContext()

  

  member this.Get() = db.Bookmarks

  

  member this.Get(id:int) = db.Bookmarks.Find(id)

  

  member this.Post(bookmark:Bookmark) = 

    bookmark |> db.Bookmarks.Add |> ignore

    db.SaveChanges() 

    |> ignore



  member this.Put(id:int, value:Bookmark) =

    let bookmark = this.Get(id)

    bookmark.Title <- value.Title

    bookmark.URL <- value.URL

    bookmark.Rating <- value.Rating

    db.SaveChanges() |> ignore



  member this.Delete(id: int) =

    id |> this.Get |> db.Bookmarks.Remove |> ignore

    db.SaveChanges() |> ignore

モデルはそんなに劇的にすっきりするわけではないが、C# が下記で、

namespace SampleAPIServer.Models

{

  public class Bookmark

  {

    public int Id { get; set; }

    public string Title { get; set; }

    public string URL { get; set; }

    public int Rating { get; set; }

  }

}

F# ならレコード型使ってこんな感じ。

namespace SampleAPIServer.Models

open System



[<CLIMutable>]

type Bookmark = {

  mutable Id : int

  mutable Title : string

  mutable URL : string

  mutable Rating : int

}

ということで、あんまり "関数型プログラミング" みたいなところにこだわらずとも、単なる軽量構文としての F# に書き換えるのは造作ない、という話。

...で話は終わらなかった!

...で終わるかと思いきや、ちょっとうれしくない事態が発生。

F# 化した API サーバーが返す JSON が、C# 版と違っていたのだ。

当初の C# 版だと下記のような JSON が返るが、

{

  "rating": 5,

  "url": "https://twitter.com",

  "title": "Twitter",

  "id": 1,

}

F# 版では下記のようになった。

{

  "rating": 5,

  "url": "https://twitter.com",

  "title": "Twitter",

  "id": 1,

  "rating@": 5,

  "urL@": "https://twitter.com",

  "title@": "Twitter",

  "id@": 1

}

なんですか、
この "id@" とか、末尾に "@" つくプロパティ
が重複して増えてるのは?

mutable なレコード型が犯人?

これはどうやら、F# のレコード型で、mutable なフィールドを設けたときに、IL のレベルでは public なフィールド ( プロパティではない ) に翻訳されて、それを (ASP.NET WebAPI の既定の JSON シリアライザである) JSON.NET がプロパティもフィールドども、シリアル化するからであるらしい。(下図は ILSpy で C# に逆コンパイルした例)
imutable な普通のレコード型であればまた違ったのかもしれないが (その場合は public ではなく internal なフィールドとして用意される)、データベースとのやりとりに Entity Framework を使っている都合上、変更可能 (mutable) にしておくほうが、コードは簡単になる。
まぁ、折角の関数型言語で mutable って何よ、という気もするが...。

対策

さいわい、ASP.NET WebAPI と JSON.NET には拡張ポイントがちゃんと用意されているため、対処は可能だ。
若干面倒なのだけれども、以下のようにコードを書き足していく。

まずは、JSON.NET に対し、フィールドは見ないで、プロパティだけシリアル化対象とするよう教えてやる必要がある。
そのために、Newtonsoft.Json.Serialization 名前空間に含まれる CamelCasePropertyNamesContractResolver クラスからの派生クラスを作り、GetSerializableMembers メソッドを上書きする。

この GetSerializableMembers メソッドが返す MemberInfo たちがシリアル化対象になるので、そこで、シリアル化対象の型のメンバの情報うち、プロパティの情報だけ返すようにするのだ。

namespace SampleAPIServer

open System

open System.Linq

open System.Reflection

open Newtonsoft.Json.Serialization



type FSRecordContractResolverWithCamelCase() =



  inherit CamelCasePropertyNamesContractResolver()



  override this.GetSerializableMembers (objectType: Type) =

    objectType

      .GetProperties()

      .Cast()

      .ToList()

こうして作成した FSRecordContractResolverWithCamelCase クラスを、ASP.NET Web API の構成中で設定してやるよう、コードを書き足す（太字の部分）。

type WebApiApplication() =

  inherit System.Web.HttpApplication()



  let ConfigureWebAPI(config : HttpConfiguration) =

    

    let contractResolver = new FSRecordContractResolverWithCamelCase()

    config.Formatters

      .JsonFormatter

      .SerializerSettings

      .ContractResolver <- contractResolver

以上で、F# 化した API サーバーでも、期待どおりの JSON が出力されるようになった。

まとめ

F# で ASP.NET WebAPI サーバーを実装する場合、Entity Framework と組み合わせて、mutable な F# レコード型をモデルに採用した場合、シリアル化された JSON にご注意、という話。
組み合わせ技の妙で、結果が残念なことになってしまう。

幸い、自前のコードを書き足して構成を正してやることで治せるけど、せっかくの軽量構文としての F# なのに記述量が増えるのはなんとも微妙な気持ちである。

以上のコードは GitHub で公開。

C# 版
https://github.com/codejp/code2014-angularjs-sampleapiserver/

F# 版は上記リポジトリの "fsharpize" ブランチにある。
https://github.com/codejp/code2014-angularjs-sampleapiserver/tree/fsharpnize/SampleAPIServerCore