Go言語 :logとfmtの違いはなんなの?

この記事は約7分で読めます。

Go言語 でよく使う、logとfmtの違いについてまとめようと思います。

【就活生必見】有名な企業からオファーが来る 逆求人 サイト
今回は就活生にオススメの 逆求人 サイトをご紹介します。 逆求人 サイトはかなり効率の良い就活の方法です。また、他の就活生と差別化することもできます。紹介しているのは全て無料です!参加するだけで、選考パスを貰えたりするので、是非参加してみてくださいね!

出力するときによく使うのは、

  • log.Println
  • fmt.Println

ですよね。

これらの違いについてまとめます。

最後に、loggingを使う上でオススメのライブラリをご紹介します。

それでは、いきましょう

TL;DR

当たり前ですが、loggingをしたい場合は、logを使った方が良いです。

fmt

  • 引数の値を標準する
  • gorutineセーフではない

log

  • 詳しく表示設定することができる
  • ログレベルでフィルタリングする機能はないため、自分で,log.Logger型で定義する必要がある
  • github.com/sirupsen/logrusがオススメ

 

logとfmtを実行してみる

まず同じ条件で実行してみます

package main

import (
	"fmt"
	"log"
)

var str = "hello world"

func main() {
	fmt.Println("fmt->",str)
	log.Println("log->",str)
}

実行結果

$go run slice.go                                                                                                                       
fmt-> hello world
2019/07/15 18:53:43 log-> hello world

何が違うの?

実行結果からみて違う点は

  • logでは、出力に加え、日時や、実行されたソースコードを表示させることができます。
  • fmtでは、そのまま標準出力として表示させます。

参考:logドキュメント

によると、

log.SetFlagをしておくことで、かなり細かく表示設定ができるそうです。

詳しく違い・特徴をみていきましょう。

  • logはstderrに出力(log.SetOutput()によって、stdoutにも可能)
  • fmtはstdoutに出力
  • logは出力時、log.Logger内のBufferを用いて整形するため、複数のgorutineからのアクセスにも対応できるよう排他制御されています。
  • fmtは出力のフォーマットをできる。(Sprintf()で好きな形でstring型の文字列に整形できる)

 

まとめると、logの方がかなり細かく設定することができます。基本的に、エラーの表示等のloggingではlogの方が使い勝手が良いと思います。

logのMottoなところ

標準のlogでは、エラーレベルのフィルタリングができません。logでは、レベル付きのロギングがついていないためです。また、出力を制御する方法も提供していません。

基本、logを出す時に振り分けを行いたい時は、

log.Logger型を自分で作成し、振り分ける必要があります。

infoLog = log.New(os.Stdout, "[INFO]", log.LstdFlags|log.LUTC)

 ライブラリを使おう

github.com/sirupsen/logrus

 

オススメのライブラリです。これを用いると、logレベルが標準で分けることができたり、ログの色から細かく設定できます。

 

package logrus_test

import (
	"os"

	"github.com/sirupsen/logrus"
)

func Example_basic() {
	var log = logrus.New()
	log.Formatter = new(logrus.JSONFormatter)
	log.Formatter = new(logrus.TextFormatter)                     //default
	log.Formatter.(*logrus.TextFormatter).DisableColors = true    // remove colors
	log.Formatter.(*logrus.TextFormatter).DisableTimestamp = true // remove timestamp from test output
	log.Level = logrus.TraceLevel
	log.Out = os.Stdout
	defer func() {
		err := recover()
		if err != nil {
			entry := err.(*logrus.Entry)
			log.WithFields(logrus.Fields{
				"omg":         true,
				"err_animal":  entry.Data["animal"],
				"err_size":    entry.Data["size"],
				"err_level":   entry.Level,
				"err_message": entry.Message,
				"number":      100,
			}).Error("The ice breaks!") // or use Fatal() to force the process to exit with a nonzero code
		}
	}()

	log.WithFields(logrus.Fields{
		"animal": "walrus",
		"number": 0,
	}).Trace("Went to the beach")

	log.WithFields(logrus.Fields{
		"animal": "walrus",
		"number": 8,
	}).Debug("Started observing beach")

	log.WithFields(logrus.Fields{
		"animal": "walrus",
		"size":   10,
	}).Info("A group of walrus emerges from the ocean")

	log.WithFields(logrus.Fields{
		"omg":    true,
		"number": 122,
	}).Warn("The group's number increased tremendously!")

	log.WithFields(logrus.Fields{
		"temperature": -4,
	}).Debug("Temperature changes")

	log.WithFields(logrus.Fields{
		"animal": "orca",
		"size":   9009,
	}).Panic("It's over 9000!")

	// Output:
	// level=trace msg="Went to the beach" animal=walrus number=0
	// level=debug msg="Started observing beach" animal=walrus number=8
	// level=info msg="A group of walrus emerges from the ocean" animal=walrus size=10
	// level=warning msg="The group's number increased tremendously!" number=122 omg=true
	// level=debug msg="Temperature changes" temperature=-4
	// level=panic msg="It's over 9000!" animal=orca size=9009
	// level=error msg="The ice breaks!" err_animal=orca err_level=panic err_message="It's over 9000!" err_size=9009 number=100 omg=true
}

まとめ

今回は、logとfmtの違いについて、まとめました。

名前の通りですが、

loggingの時はlogを用いた方が良さげです。

標準のlogはシンプルすぎるので、ライブラリを用いて,レベルフィルタリングをするのをオススメします。

fmtはフォーマットを作成するときに使います。fmt.Sprintf()はフォーマットを作成して、string型の文字列を生成してくれます。

 

プログラミング独学にはUdemyが良い (オススメ動画あり)

タイトルとURLをコピーしました