oinume journal

Scratchpad of what I learned

読書: 新しい文章力の教室

自分の文章力を高めたいと思ってこの本を買ってみた。仕事ではドキュメントを書いたり、プライベートではこのブログを書いている。けれども、文章を書くということをちゃんと学んだことがなかったのと、自分の書いたものを読み返してみても「文才がないなぁ」という感想しか出てこないのでブラッシュアップしたかった。

完全に自分用のメモだけどメモとして残しておく。

良い文章の定義

  • 良い文章とは完読される文章である。
  • 適切な長さで、旬の話題で、テンポがいい文章
  • レイヤーが大事。事実、ロジック、言葉遣いの順番で大切。

主眼と骨子

  • 書き始める前に主眼と骨子を固めること。主眼はテーマ。主眼が目的地なら骨子は経路。
  • テーマを決める。そしてテーマのために、何を、どれから、どのくらい話すかを決める。
  • プラモデルのように考える。
  • 書きたい内容を箇条書きにしておく。この時順番は意識しなくて良い。主眼と骨子を考えるためにもひたすら書き出す。
  • 5W1Hに当てはめて考える。抜け漏れがないかのチェックになる
    • Who, What, When, Where, Why, How
  • 書き始める前に主眼を決めること。主眼はコンセプト。切り口。自分なりの切り口を考える
  • 骨子を立てるために大事なのは要素、順番、軽重の順で決めること。
  • それぞれの話題をどれぐらいの重さで話すか、三段階で決める。

構造シート

以下のような構造シートを書いて情報を整理する。

  1. 紙の上方に大きく線を引いて、テーマ(主眼)を書く欄を作る。この段階では空欄のままでよい。
  2. 箇条書きで、書こうとする話題を列挙していく
  3. 並んだ話題を眺めながらこれから各文章の主眼を見定め、テーマ欄に書き込む
  4. どの話題から切り出していくべきか、主眼に準じるよう吟味し、項目の左横に順番を数字で書き込んでいく
  5. 紙を替え、テーマ欄に主眼を書き込み、順番通りに並べ直します。もししっくり来なければ、また順番を吟味して書き込み、紙を替えてやり直す
  6. アピールしたい優先度を、項目の右側にABCの3ランクで格付けしていく

実際の構造シートの例

完読してもらうためのテクニック

  • ベテランのライターもいきなり文章を書き始めるのではなく、瞬間的に心の中に構造シートを書き込み、その後に文章を書き始めている
  • 話題は主眼に沿って取捨選択する。完読してもらうためにはすべての材料を使わない
  • 結論から先にいう
  • 構造シートに肉付けして行く形で文章を書いて行く

書けなくなった時は?

  • スタックしてしまった部分を置いて最後まで書いてしまう。また、2000字を超える場合はパートごとに構造シートを書くと良い。
  • それでも書く手が止まってしまう場合は構造シートに問題がある場合が多い。 

完成度を高める

  • 事実とロジックがしっかりしていれば70点ぐらいにはなっている。あとは言葉遣いでブラッシュアップする。

Goのhttp.Handlerやhttp.HandlerFuncをちゃんと理解する

はじめに

GoでHTTP Serverを作ろうとすると、標準ライブラリを使う場合以下のようなコードをよく書くと思う。

package main

import (
    "fmt"
    "log"
    "net/http"
)

func main() {
    mux := http.NewServeMux()
    mux.Handle("/hello", http.HandlerFunc(hello))
    log.Fatal(http.ListenAndServe(":8080", mux))
}

func hello(w http.ResponseWriter, _ *http.Request) {
    w.WriteHeader(http.StatusOK)
    fmt.Fprintf(w, "Hello World")
}

このコードの登場人物としては以下になるが、それぞれなんだっけ?というのをいっつも忘れてしまうのでメモしておく。

  • http.ListenAndServe
  • http.Handler
  • http.HandleFunc
  • http.ServeMux
  • http.ServeMux.Handle
  • http.ServeMux.HandleFunc

http.ListenAndServe

http.ListenAndServe はその名前の通りサーバーを起動するものである。

  • 第1引数にTCPのアドレス
  • 第2引数にhttp.Handler

を渡す。この第2引数のhttp.Handlerってなに?というのを次のセクションで説明する。

http.Handler

http.HandlerはServeHTTP というメソッドを定義しているinterface。以下がそのメソッドの定義。このServeHTTPメソッドはHTTPリクエストを受けてHTTPレスポンスを返す処理が記述されるものである。

type Handler interface {
    ServeHTTP(ResponseWriter, *Request)
}

後述するhttp.ServeMuxのHandleメソッドの引数がこのinterface型になっている。

func (mux *ServeMux) Handle(pattern string, handler Handler) {
    ....
}

http.ServeMux

http.ServeMuxには、HTTPリクエストのURLとそれに対応するハンドラを登録する。HTTPリクエストが来た時に、そのURLにマッチしたハンドラを呼び出すマルチプレクサである。godoc.orgからの引用。

ServeMux is an HTTP request multiplexer. It matches the URL of each incoming request against a list of registered patterns and calls the handler for the pattern that most closely matches the URL.

ServeMux.Handleメソッドを呼び出して以下のようにURLのPathとHandlerを登録しておく。例えばHTTPリクエストのURLが /echo の場合、echoHandlerのServeHTTPメソッドが呼び出される。

func main() {
    mux := http.NewServeMux()
    mux.Handle("/echo", echoHandler)
    ...
}

type echoHandler struct{}

func (h *echoHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
    w.WriteHeader(http.StatusOK)
    fmt.Fprintf(w, "Hello World")
}

なお、http.ServeMuxはServeHTTPメソッドを実装しているので、http.ListenAndServeの第2引数に渡すことができる。

http.HandlerFunc

  • func(ResponseWriter, *Request) を別の型として定義したもの
  • このHandlerFunc型にはServeHTTP(ResponseWriter, *Request)メソッドが実装されている。func(http.ResponseWriter, *http.Request) のシグネチャの関数を自分で定義しておき、このHandlerFuncにキャストするだけで構造体を宣言することなく http.Handler を実装することができる
  • godocには The HandlerFunc type is an adapter to allow the use of ordinary functions as HTTP handlers. If f is a function with the appropriate signature, HandlerFunc(f) is a Handler that calls f. と書かれている。

実際のコードはこんな感じ。HandlerFunc自体にServeHTTPがあり、その中では元の関数であるfを呼び出しているだけ。

type HandlerFunc func(ResponseWriter, *Request)

// ServeHTTP calls f(w, r).
func (f HandlerFunc) ServeHTTP(w ResponseWriter, r *Request) {
    f(w, r)
}

いまいちイメージしづらいので、使う側のコードを書いてみる。

func hello(w http.ResponseWriter, r *http.Request) {
    w.WriteHeader(http.StatusOK)
    fmt.Fprintf(w, "Hello World")
}

func main() {
    mux := http.NewServeMux()
    mux.Handle("/hello", http.HandlerFunc(hello)) // helloをHandlerFuncにキャスト
}
  • helloをhttp.HandlerFuncにキャスト
  • http.HandlerFuncは ServeHTTP を実装しているので、ServeMux.Handleの第2引数に指定することが可能。

という仕組みになっている。先程のServeHTTPのサンプルコードだと、echoHandlerというstructを定義してそこにServeHTTPメソッドを定義する必要があったが、このコードではそのような構造体は必要ないことがわかると思う。

http.ServeMux.HandleFunc

ServeMuxにはHandleメソッド以外にもHandleFuncというメソッドが定義されている。コードとしてはこんな感じの実装になっている。

// HandleFunc registers the handler function for the given pattern.
func (mux *ServeMux) HandleFunc(pattern string, handler func(ResponseWriter, *Request)) {
    mux.Handle(pattern, HandlerFunc(handler))
}

この実装を見ればわかるように、第2引数のhandlerをHandlerFuncにキャストして、自身のHandleを呼び出しているだけである。

呼び出し側のコードはこんな感じになる。

mux := http.NewServeMux()
mux.HandleFunc("/hello", func(w http.ResponseWriter, r *http.Request) {
    w.WriteHeader(http.StatusOK)
    fmt.Fprintf(w, "Hello World")
})

何が嬉しいのかというと、func(http.ResponseWriter, *http.Request)を自分でhttp.HandlerFuncにキャストしなくてもよいということ。自分はServeMux.HandleとServeMux.HandleFuncのどちらを使えばいいんだっけ?といつも混乱しているけど、HandleFuncはHandleのショートカットだと思えば良い。

http.HandleDefaultServeMux

http.Handleもまたショートカットである。

  • httpパッケージ内にDefaultServeMuxというグローバル変数が定義されている
  • http.Handleを呼び出すとこのDefaultServeMux.Handleが呼び出される

という仕組み。http.HandleFuncも同様に定義されていて、これもDefaultServeMux.HandleFuncが呼び出されるだけだ。

まとめ

似たような名前のものがあってややこしいけど

  • http.HandlerはServeHTTPメソッドを定義するinterface
  • http.HandlerFuncを使えばServeHTTPを実装するstructを作らなくて良い
  • ServeMux.HandleメソッドでPathとhttp.Handlerのマッピングを登録する

というのだけ最低限覚えておけば良いのかなと思う。あとは応用。なお、例として挙げたサンプルコードはここにあがってる。

参考リンク

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES)

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES)

2018年6月の振り返り

機械学習

進捗なし

アルゴリズム

ブロックチェーン

進捗なし

lekcijeの月額課金

  • Stripeでsubscriptionの初月無料が簡単にできるということがわかった
  • その他細々とした修正

プライベート

資産運用

  • WealthNaviとクラウドバンクの口座を作った
  • Netflixの株を少し買った

7月に向けて

Kubernetesも勉強しないとなー... 何を優先で勉強するか悩ましい...

2018年5月の振り返り

機械学習

Udemyのキカガクのコースは全部やり終わって、単回帰分析ならできそうな気がしてきた

アルゴリズム

  • hash のオープンアドレス法の実装やってない

ブロックチェーン(New)

lekcijeの月額課金

  • Stripeの機能はだいたい調べ終わって、ちょっとずつ実装しているところ。進捗10%
  • 関係ないけどGoogle Data Studioが便利だった。MySQLのデータもDataSourceに指定できる。
  • Reactで実装しているページにLoadingが出るようにした。react-loading-overlayというやつを使ったんだけど楽ちんだった。

プライベート

  • Netflixのザ・キーパーズ観始めて面白すぎてはまった。
  • 楽天マガジンに課金した。月410円で雑誌読み放題の破壊力はすごい。本屋だと立ち読みできない女性誌とか見るのが楽しい。Twitter見るぐらいだったら雑誌読んでいた方が知識が増えてよい。
  • 昨年末に申請したe-Redisdencyカードをやっと受け取った。これは詳しくブログに書きたい。
  • OculusGo買った。ホラー系のゲームが怖すぎてすごい。バイオとか出ないかな?

Dropbox Paper

  • 個人で開発しているサービスの仕様書やメモをwri.peからDropbox Paperに移行した
  • Markdownで書けるのとGoogle docsより動作が軽快なのが好き

6月に向けて

イーサリアムやっていくぞ!

Generating an unpredictable random value in Go

There are a lot of examples to use math/rand. However, should use crypto/rand if you want to generate an unpredictable random value. That's because crypto/rand uses getrandom(2) if available, /dev/urandom otherwise on Linux.

As a real world example, UUID v4 uses crypto/rand internally. UUID v4) is randomly generated. An implementation of UUID v4 in Go uses crypto/rand internally.

Here is an example to generate random values with crypto/rand.

Generate random integer

func generateInt(n int64) (int64, error) {
    r, err := rand.Int(rand.Reader, big.NewInt(n))
    if err != nil {
        return 0, err
    }
    return r.Int64(), nil
}

Generate random string

func generateString(length int) (string, error) {
    b := make([]byte, length)
    _, err := rand.Read(b)
    if err != nil {
        return "", err
    }
    return base64.URLEncoding.EncodeToString(b), nil
}

Whole source code

package main

import (
    "crypto/rand"
    "encoding/base64"
    "fmt"
    "log"
    "math/big"
)

func main() {
    v, err := generateInt(1000)
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("random int = %v\n", v)

    s, err := generateString(10)
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("random string = %v\n", s)
}

func generateInt(n int64) (int64, error) {
    r, err := rand.Int(rand.Reader, big.NewInt(n))
    if err != nil {
        return 0, err
    }
    return r.Int64(), nil
}

func generateString(length int) (string, error) {
    b := make([]byte, length)
    _, err := rand.Read(b)
    if err != nil {
        return "", err
    }
    return base64.URLEncoding.EncodeToString(b), nil
}