Go言語数値処理：big.Int.UnmarshalText() と SetString() の違い

2025-06-01

具体的には、以下のような処理を行います。

入力の受け取り
UnmarshalText() メソッドは、[]byte 型のスライスまたは string 型のテキストを受け取ります。このテキストは、整数値を文字列として表現したものです。例えば、"12345" や "-9876" のような形式です。
テキストの解析
受け取ったテキストを解析し、それが有効な整数表現であるかどうかを確認します。これには、符号（オプションの + または -）、数字が含まれているかどうかのチェックなどが含まれます。
big.Int への変換
解析が成功した場合、テキストで表現された整数値が big.Int 型の内部表現に変換され、メソッドを呼び出した big.Int 変数にその値が設定されます。
エラー処理
テキストが有効な整数表現でない場合（例えば、数字以外の文字が含まれているなど）、UnmarshalText() はエラーを返します。このエラーをチェックすることで、入力が正しく解析されたかどうかを確認できます。

メソッドのシグネチャ

func (z *Int) UnmarshalText(text []byte) error

または

func (z *Int) UnmarshalText(text []byte) (err error)

ここで、

error: 解析に失敗した場合に返されるエラーです。成功した場合は nil が返ります。
text: 整数値を表す []byte 型のスライスです。
z: 値を設定する対象の big.Int 型のポインタです。

使用例

package main

import (
	"fmt"
	"math/big"
)

func main() {
	// []byte 型のテキストから読み込む例
	byteText := []byte("12345678901234567890")
	var num1 big.Int
	err1 := num1.UnmarshalText(byteText)
	if err1 != nil {
		fmt.Println("Error unmarshaling byte text:", err1)
	} else {
		fmt.Println("Number from byte text:", &num1)
	}

	// string 型のテキストから読み込む例
	stringText := "-98765432109876543210"
	var num2 big.Int
	err2 := num2.UnmarshalText([]byte(stringText)) // string を []byte に変換
	if err2 != nil {
		fmt.Println("Error unmarshaling string text:", err2)
	} else {
		fmt.Println("Number from string text:", &num2)
	}

	// 無効なテキストの例
	invalidText := []byte("abc123")
	var num3 big.Int
	err3 := num3.UnmarshalText(invalidText)
	if err3 != nil {
		fmt.Println("Error unmarshaling invalid text:", err3)
	} else {
		fmt.Println("Number from invalid text:", &num3) // ここは実行されないはず
	}
}

無効な数値形式のエラー (strconv.NumError)

トラブルシューティング
- 入力データの検証
  UnmarshalText() に渡す前に、入力文字列が期待される数値形式（オプションの符号と数字のみ）になっているかを事前にチェックする。正規表現などを使用して検証することが有効です。
- エラーハンドリング
  UnmarshalText() が返すエラーを必ず確認し、エラーが発生した場合は適切なエラーメッセージを出力したり、処理を中断したりする。
- ログ出力
  問題が発生した際の調査のために、入力文字列をログに出力するようにする。
原因
- 入力データに数字以外の文字（アルファベット、記号など）が含まれている。
- 符号 (+ または -) が数値の先頭以外に現れている。
- 空の文字列や空白文字のみの文字列が入力された。
- 数値が big.Int の表現範囲を超える（実際には UnmarshalText 自体は範囲チェックは行いませんが、その後の処理で問題になる可能性があります）。
エラーメッセージの例
strconv.ParseInt: parsing "abc": invalid syntax のように、strconv.ParseInt に関連するエラーメッセージが出力されることがあります。これは、内部的に strconv パッケージの関数が使用されているためです。
エラー内容
UnmarshalText() に渡されたテキストが、有効な整数としての形式を満たしていない場合に発生します。これには、数字以外の文字が含まれている、予期しない符号の位置にある、空の文字列であるなどが含まれます。

nil レシーバによるエラー (Panic)

トラブルシューティング
- big.Int 型の変数に対して UnmarshalText() を呼び出す前に、必ず new(big.Int) でポインタを初期化するか、値レシーバで操作する場合は値型の変数を宣言・初期化する。UnmarshalText はポインタレシーバなので、ポインタ型で扱う必要があります。
```
var num big.Int // これは値型
ptrNum := new(big.Int) // これはポインタ型

// num.UnmarshalText(...) // これはコンパイルエラーになる可能性あり

err := ptrNum.UnmarshalText([]byte("123"))
if err != nil {
    // エラー処理
}
```
原因
big.Int 型の変数を宣言しただけで、明示的に初期化（例えば new(big.Int) を使用）せずに UnmarshalText() を呼び出した。
エラーメッセージの例
panic: runtime error: invalid memory address or nil pointer dereference
エラー内容
UnmarshalText() はポインタレシーバ (*Int) に対して呼び出す必要があります。もし nil の big.Int ポインタに対してこのメソッドを呼び出すと、ランタイムパニックが発生します。

原因
基盤となるライブラリのバグ（可能性は低いですが）、メモリの問題などが考えられます。
エラー内容
まれに、上記以外の予期しないエラーが発生する可能性があります。

トラブルシューティングの一般的なアプローチ

テストケースの作成
さまざまな入力パターン（正常なケース、異常なケース、境界値など）に対するテストケースを作成し、コードの振る舞いを検証することが重要です。
デバッガの使用
デバッガを使用してコードをステップ実行し、変数の値の変化や処理の流れを確認することで、問題の原因を特定できる場合があります。
ログ出力の活用
入力データや処理の途中経過をログに出力することで、問題発生時の状況を把握しやすくなります。
エラーメッセージの正確な把握
発生したエラーメッセージを正確に理解することが、問題解決の第一歩です。

例1: 基本的なテキストからの読み込み

この例では、[]byte 型と string 型のテキストから big.Int 型の変数に値を読み込みます。

package main

import (
	"fmt"
	"math/big"
)

func main() {
	// []byte 型のテキスト
	byteText := []byte("1234567890")
	var num1 big.Int
	err1 := num1.UnmarshalText(byteText)
	if err1 != nil {
		fmt.Println("[]byte からの読み込みエラー:", err1)
	} else {
		fmt.Println("[]byte からの数値:", &num1)
	}

	// string 型のテキスト（[]byte に変換して渡す）
	stringText := "-9876543210"
	var num2 big.Int
	err2 := num2.UnmarshalText([]byte(stringText))
	if err2 != nil {
		fmt.Println("string からの読み込みエラー:", err2)
	} else {
		fmt.Println("string からの数値:", &num2)
	}
}

解説

エラーが発生した場合はエラーメッセージを出力し、成功した場合は読み込んだ big.Int の値を出力しています。string 型のテキストを渡す際には、[]byte() でバイトスライスに変換する必要があることに注意してください。
UnmarshalText() メソッドをそれぞれのテキストデータに対して呼び出し、読み込んだ値を num1 と num2 に設定しています。
big.Int 型の変数 num1 と num2 を宣言しています。
[]byte 型の byteText と string 型の stringText を用意しています。

例2: 無効な形式のテキストを処理する

この例では、無効な形式のテキストを UnmarshalText() に渡し、エラー処理を行う方法を示します。

package main

import (
	"fmt"
	"math/big"
)

func main() {
	invalidText := []byte("abc123xyz")
	var num big.Int
	err := num.UnmarshalText(invalidText)
	if err != nil {
		fmt.Println("無効なテキストのエラー:", err)
	} else {
		fmt.Println("読み込まれた数値:", &num) // ここは実行されないはず
	}

	emptyText := []byte("")
	var num2 big.Int
	err2 := num2.UnmarshalText(emptyText)
	if err2 != nil {
		fmt.Println("空のテキストのエラー:", err2)
	} else {
		fmt.Println("読み込まれた数値 (空):", &num2) // ここも実行されないはず
	}
}

解説

エラーが発生した場合、そのエラーメッセージを出力することで、入力が不正であることを検知できます。
UnmarshalText() はこれらの無効なテキストを解析しようとし、エラーを返します。
数字以外の文字を含む invalidText と、空の emptyText を用意しています。

例3: 大きな数値を扱う

big.Int の主な利点は、標準の整数型よりもはるかに大きな数値を扱えることです。この例では、非常に大きな数値をテキストから読み込みます。

package main

import (
	"fmt"
	"math/big"
)

func main() {
	largeNumberText := []byte("1234567890123456789012345678901234567890")
	var largeNum big.Int
	err := largeNum.UnmarshalText(largeNumberText)
	if err != nil {
		fmt.Println("大きな数値の読み込みエラー:", err)
	} else {
		fmt.Println("読み込まれた大きな数値:", &largeNum)
	}
}

解説

UnmarshalText() を使用することで、この大きな数値を big.Int 型の largeNum に正確に読み込むことができます。
標準の整数型では表現できないような非常に大きな数値を文字列として largeNumberText に格納しています。

例4: JSON デシリアライズとの組み合わせ

big.Int は、JSON などのテキスト形式のデータから数値を読み込む際にも役立ちます。カスタムアンマーシャラーを実装することで、JSON の文字列形式の数値を big.Int に直接マッピングできます。

package main

import (
	"encoding/json"
	"fmt"
	"math/big"
)

// JSON で文字列として表現された大きな整数を格納する構造体
type Data struct {
	ID  int64      `json:"id"`
	Value *big.Int `json:"value"`
}

// big.Int のカスタムアンマーシャラー
func (z *big.Int) UnmarshalJSON(b []byte) error {
	var s string
	if err := json.Unmarshal(b, &s); err != nil {
		return err
	}
	_, ok := z.SetString(s, 10) // 10進数として解析
	if !ok {
		return fmt.Errorf("invalid big integer: %s", s)
	}
	return nil
}

func main() {
	jsonData := `{"id": 1, "value": "98765432109876543210"}`
	var data Data
	err := json.Unmarshal([]byte(jsonData), &data)
	if err != nil {
		fmt.Println("JSON デシリアライズエラー:", err)
	} else {
		fmt.Println("ID:", data.ID)
		fmt.Println("Value:", data.Value)
	}
}

json.Unmarshal() を使用して JSON データを Data 構造体にデシリアライズする際に、このカスタムアンマーシャラーが自動的に呼ばれ、文字列形式の大きな整数が big.Int 型に変換されます。
big.Int 型にカスタムの UnmarshalJSON メソッドを実装しています。このメソッドは、JSON の文字列として表現された数値を SetString メソッドを使って big.Int に設定します。
Data 構造体には、big.Int 型のフィールド Value が含まれています。

big.Int.SetString() メソッドの使用

big.Int 型には、テキスト形式の数値を直接設定するための SetString() メソッドがあります。UnmarshalText() と同様の機能を提供しますが、基数（進数）を指定できる点が異なります。

package main

import (
	"fmt"
	"math/big"
)

func main() {
	// 10進数の文字列から読み込む
	decimalStr := "1234567890"
	num1 := new(big.Int)
	_, ok1 := num1.SetString(decimalStr, 10)
	if !ok1 {
		fmt.Println("10進数文字列の変換に失敗:", decimalStr)
	} else {
		fmt.Println("10進数の数値:", num1)
	}

	// 16進数の文字列から読み込む
	hexStr := "1A2B3C"
	num2 := new(big.Int)
	_, ok2 := num2.SetString(hexStr, 16)
	if !ok2 {
		fmt.Println("16進数文字列の変換に失敗:", hexStr)
	} else {
		fmt.Println("16進数の数値:", num2)
	}

	// 無効な形式の文字列
	invalidStr := "xyz"
	num3 := new(big.Int)
	_, ok3 := num3.SetString(invalidStr, 10)
	if !ok3 {
		fmt.Println("無効な文字列の変換に失敗:", invalidStr)
	} else {
		fmt.Println("無効な文字列の数値:", num3) // ここは実行されないはず
	}
}

解説

戻り値は、設定が成功したかどうかを示す bool 型の値です。エラーが発生した場合は false が返ります。
base には、2 から 62 までの値、または 0 を指定できます。0 を指定すると、プレフィックス ("0b"、"0o"、"0x") に基づいて基数が自動的に決定されます。
SetString(s string, base int) は、文字列 s を base 進数の整数として解析し、レシーバの big.Int にその値を設定します。

UnmarshalText() との主な違い

SetString() はエラーを error 型ではなく bool 型で返します。
UnmarshalText() は常に 10 進数として解析しますが、SetString() は基数を指定できます。

fmt.Sscan() などのフォーマット済み入力関数を使用 (非推奨)

fmt パッケージの Sscan() などの関数を使用して、文字列からフォーマットに従って値を読み込むことも理論的には可能ですが、big.Int に対して直接的なフォーマット指定がないため、通常は推奨されません。一度標準の整数型に読み込んでから big.Int に変換する手間が増えます。

package main

import (
	"fmt"
	"math/big"
)

func main() {
	str := "1234567890"
	var intVal int64
	_, err := fmt.Sscan(str, &intVal)
	if err != nil {
		fmt.Println("fmt.Sscan エラー:", err)
	} else {
		bigIntVal := new(big.Int).SetInt64(intVal)
		fmt.Println("fmt.Sscan で読み込んだ数値:", bigIntVal)
	}

	largeStr := "12345678901234567890" // int64 の範囲を超える
	var largeIntVal int64
	_, err2 := fmt.Sscan(largeStr, &largeIntVal)
	if err2 != nil {
		fmt.Println("fmt.Sscan (大きな数値) エラー:", err2)
	} else {
		bigLargeIntVal := new(big.Int).SetInt64(largeIntVal) // 情報が失われる可能性
		fmt.Println("fmt.Sscan (大きな数値) で読み込んだ数値:", bigLargeIntVal)
	}
}

注意点

大きな数値を扱う場合は、情報が失われる可能性があるため、この方法は避けるべきです。
fmt.Sscan() は、オーバーフローなどのエラーを適切に検出できない場合があります。

自力で解析する (特殊な形式の場合)

もし入力テキストが標準的な整数形式ではない場合（例えば、特定の区切り文字が含まれている、独自のエンコーディングがされているなど）、自力で文字列を解析し、big.Int のメソッド（例えば Add(), Mul() など）を使って値を構築する必要があるかもしれません。これは複雑な処理になるため、特別な理由がない限り推奨されません。

big.Int.UnmarshalText() の代替として最も一般的で推奨されるのは、big.Int.SetString() メソッドです。こちらは基数を指定できるため、10進数以外の形式のテキストから big.Int を生成する場合に非常に便利です。

fmt.Sscan() などのフォーマット済み入力関数は、big.Int を直接扱えないため、通常は避けるべきです。自力での解析は、非常に特殊な状況でのみ検討するべきでしょう。

Go言語 数値処理：big.Int.UnmarshalText() と SetString() の違い

無効な数値形式のエラー (strconv.NumError)

例1: 基本的なテキストからの読み込み

big.Int.SetString() メソッドの使用

Go言語数値処理：big.Int.UnmarshalText() と SetString() の違い