Go Advent Calendar 2016 16日目です。去年に引き続き今年も3つカレンダーがあり相変わらずの人気ですね。

さて、Go1.8では待望?のShared Libraryのロードが可能になります。 pluginパッケージ を使います。

Go1.8beta1ではLinuxとMacOSがサポートされていたのですが、MacOSで問題が見つかりbeta2ではLinuxのみで利用可能な機能となります。

Advent Calendar 2の qt-luigiさんのネタ と被ってしまったのですが実戦的に使ってみました、ということで許してください。

プラグインの作成とコンパイル

マニュアルページにあるとおり、以下のようになります。

 package main

 // // No C code needed.
 import "C"

 import "fmt"

 var V int

 func F() { fmt.Printf("Hello, number %d\n", V) }

ポイントは

  • Cのコードはないが、 import "C" が必要
  • packagemain

という2点です。コンパイルは

 $ go build -buildmode=plugin -o plugin.so plugin.go

でOK。簡単ですね。これで plugin.so が生成されます。

プラグインのロード

これまたマニュアルページどおりですが

 p, err := plugin.Open("plugin.so")
 if err != nil {
     panic(err)
 }
 v, err := p.Lookup("V")
 if err != nil {
     panic(err)
 }
 f, err := p.Lookup("F")
 if err != nil {
     panic(err)
 }
 *v.(*int) = 7
 f.(func())() // prints "Hello, number 7"

のように非常に直感的に使えます。

GopherLuaで使ってみた

拙作のPure GoによるLua実装 GopherLua ですが(何気にstarいっぱいでうれしいですね)、当然ながらC言語実装のように共有ライブラリをロードできませんでした。

そのため、必要なライブラリはすべて事前に組み込んでおく必要がありました。そこでGo1.8で共有ライブラリロードを実装できるのか、実装できるだろうけどちゃんと動くのか、と思い試してみました。

こちらは feature-exp-go1.8pluginsブランチ で実際に動かせます。プラグイン部分のコミットは 571b031 です。

まずプラグイン側から。Luaのお作法通りです。

 package main

 import (
     "C"
     "github.com/yuin/gopher-lua"
 )

 func Add(L *lua.LState) int {
     v1 := L.CheckInt(1)
     v2 := L.CheckInt(2)
     L.Push(lua.LNumber(v1 + v2))
     return 1
 }

 func LuaOpenPlugin(L *lua.LState) int {
     L.Push(
             L.SetFuncs(L.NewTable(), map[string]lua.LGFunction{
                     "add": Add,
             }))
     return 1
 }

C実装のLuaでは luaopen_共有ライブラリファイル名 が実行されるのですがそこはGoの命名規則に合わせました。違いはそれくらいですね。

こいつをコンパイルして・・・

 $ cd /home/yuin/tmp/plugin
 $ go build -buildmode=plugin -o plugin.so plugin.go

こうじゃ

$ glua
> package.cpath = package.cpath .. ";" .. "/home/yuin/tmp/plugin/?.so"
> adder = require("plugin")
> print(adder.add(1, 2))
3

おおおおおおおおおおおおお

普通に動きますね。素晴らしい。ちなみに、「ロードする側」と「ロードされる側(すなわちプラグイン)」のバージョンが違うと以下のようにエラーになります。この判定が結構厳しいので(プラグインが参照していない部分の更新でもダメっぽい)、事前にプラグインをコンパイルしておいて配布、は難しいのではないでしょうか。

<string>:1: plugin.Open: plugin was built with a different version of package github.com/yuin/gopher-lua

package.loadlib も実装しました。

$ glua
> print(package.loadlib("/home/yuin/tmp/plugin/notfound", "foo"))
nil plugin.Open(/home/yuin/tmp/plugin/notfound): realpath failed    open
> print(package.loadlib("/home/yuin/tmp/plugin/plugin.so", "foo"))
nil plugin: symbol foo not found in plugin plugin/unnamed-16c3f13f46f4b66b64ad316d78cd61078d12ac64  init
> print(package.loadlib("/home/yuin/tmp/plugin/plugin.so", "LuaOpenPlugin"))
function: 0xc4200c9840
>

完璧ですね。

pluginパッケージ、使えそうですが・・・

少なくとも、Linuxでは plugin パッケージは使えそうです。ただし、本体と共有ライブラリのコンパイル時、完全にバージョンを合わせる必要があるところが難しそう。

Goの大きなメリットである単一バイナリ配布や、クロスコンパイルと相性は悪いですがうまく使っていければいいなと思います。


たまには実用的なものをつくろうと思って、Go+Luaで置くだけで動くチャットボットを作ってみました。Slack, IRC, Hipchatをサポートしています。

チャットボットといえばHubotだと思いますが、もっとさくっと動かしたいという方におすすめです。置けばうごきます。

特徴は以下です。

  • Goなので置けば動く
  • それでいてLuaでスクリプトを書ける
  • 最初からマルチスレッド(複数goroutine)を考慮している
  • HTTP(S)サーバ機能があるのでWEBHOOKも一緒に作れる
  • 定期ジョブも流せる
function main()
  local bot = golbot.newbot("Slack", { token = "xxxxx" })

  bot:respond([[\s*(\d+)\s*\+\s*(\d+)\s*]], function(m, e) -- 3
    bot:say(e.target, tostring(tonumber(m[2]) + tonumber(m[3])))
  end)

  bot:serve(function(msg)
    if msg.type == "say" then
      bot:say(msg.channel, msg.message)
      respond(msg, true)
    end
  end)
end

こんな感じのよくあるAPIです。特徴的なのがworkerの仕組みで

function main()
  bot:respond([[deploy]], function(m, e)
    bot:say(e.target, "accepted")
    goworker({target=e.target, type="deploy"})
  end)

  bot:serve(function(msg)
    if msg.type == "say" then
      bot:say(msg.target, msg.message)
    end
  end)
end

function worker(msg)
  if msg.type == "deploy" then
    do_deploy()
    notifymain({type="say", target=msg.target, message="your deployment has been completed"})
  end
end

このように goworker でLuaからGoroutineをつくって重い処理などをWorkerで実行することができます。Workerからは notifymain でメインGroutineにメッセージをおくることができます。

HTTPサーバ機能では以下のような関数を定義するだけで簡単にWEBHOOKが作れます。

 function http(r)
   if r.method == "POST" and r.URL.path == "/webhook" then
     local data = assert(json.decode(r:readbody()))
     local message = data.item.message.message
     local user = data.item.message.from.name
     local room = data.item.room.name

     local ret = {
       message = "hello! from webhook",
       message_format = "html"
     }

     return 200, headers, json.encode(ret)
   end
   return 400, headers, json.encode({result="not found"})
 end

定期ジョブは以下のような感じ。

 function main()
   golbot.newbot("Null", {
     http = "0.0.0.0:6669" ,
     crons = {
       { "0 * * * * * ", "job1"}
     }
   }):serve(function() end)
 end

 function job1()
   print "hello!"
 end

チャットボットのためだけにNode.jsとnpmはちょっと・・・という場合にぜひ。


日本人である以上、いくらUTF-8が主権を得てきたといっても文字コード変換というカルマからは逃れられません。Pure Goでの文字コード変換はLLに比べるといろいろめんどくさい。

それに、そのままだと任意の文字コードを指定させるのが難しい。特定の文字コード決め打ちならいいんですけど、全世界の利用者に向けて任意の文字コード設定できるようにする場合とかはさらにめんどくさいし、かといって iconv に依存するのも嫌なのライブラリにしました。

以下のような感じで簡単に文字コードを変換できます。Pythonと同じで encode がUTF-8からUTF-8以外へ、 decode がUTF-8以外からUTF-8へ、です。内部では golang.org/x/net/html/charset を使っているので文字コードの指定もそれに習います。(WHATWGで定義されている名前になります) 。なので cp932 などではなく Windows-31J です。

 b, err = EncodeString("こんにちわ", "Windows-31J")
 b, err = Encode("こんにちわ", "Windows-31J")
 b, err = EncodeBytes([]byte("こんにちわ"), "Windows-31J")
 b, err = EncodeReader(strings.NewReader("こんにちわ"), "Windows-31J")
 b = MustEncodeString("こんにちわ", "Windows-31J")
 b = MustEncode("こんにちわ", "Windows-31J")
 b = MustEncodeBytes([]byte("こんにちわ"), "Windows-31J")
 b = MustEncodeReader(strings.NewReader("こんにちわ"), "Windows-31J")

 s, err = DecodeString(string(source), "Windows-31J")
 s, err = Decode(source, "Windows-31J")
 s, err = DecodeBytes(source, "Windows-31J")
 s, err = DecodeReader(bytes.NewReader(source), "Windows-31J")
 s = MustDecodeString(string(source), "Windows-31J")
 s = MustDecode(source, "Windows-31J")
 s = MustDecodeBytes(source, "Windows-31J")
 s = MustDecodeReader(bytes.NewReader(source), "Windows-31J")