Go言語入門：効果的なGo -Names:MixedCaps-

よっしー

こんにちは。よっしーです(^^)

本日は、Go言語を効果的に使うためのガイドラインについて解説しています。

背景

Go言語を学び始めて、より良いコードを書きたいと思い、Go言語の公式ドキュメント「Effective Go」を知りました。これは、いわば「Goらしいコードの書き方指南書」になります。単に動くコードではなく、効率的で保守性の高いコードを書くためのベストプラクティスが詰まっているので、これを読んだ時の内容を備忘として残しました。

Effective Go - The Go Programming Language

Go言語の命名規則（Names）

命名の重要性

Go言語において、名前は他の言語と同様に重要です。名前は単なる識別子以上の意味を持ち、セマンティック（意味論的）な効果も持ちます。パッケージ外部からの可視性は、名前の最初の文字が大文字かどうかで決まります。そのため、Go プログラムにおける命名規則について時間をかけて議論する価値があります。

Go言語のMixedCaps（キャメルケース）

基本原則

最後に、Go言語の慣習では、複数語の名前を書く際にアンダースコアではなく MixedCaps または mixedCaps を使用します。

Go言語のスタイル（推奨）

// ✅ MixedCaps（パスカルケース）- エクスポートされる識別子
type UserAccount struct { ... }
func ParseHTMLDocument() { ... }
var MaxConnectionCount int

// ✅ mixedCaps（キャメルケース）- エクスポートされない識別子
var userName string
func readFileContent() { ... }
type httpClient struct { ... }

他言語でよく見られるスタイル（Go では避ける）

// ❌ スネークケース（Go では使わない）
var user_name string
func read_file_content() { ... }
type http_client struct { ... }
var MAX_CONNECTION_COUNT int

// ❌ ケバブケース（Go では使えない）
// var user-name string  // コンパイルエラー

変数名

// ✅ 正しい Go スタイル
var serverURL string
var maxRetryCount int
var isConnected bool
var userID int64
var httpResponse *http.Response

// ❌ 避けるべきスタイル
var server_url string
var max_retry_count int
var is_connected bool
var user_id int64

関数名

// ✅ エクスポートされる関数（大文字開始）
func ParseJSONData(data []byte) error { ... }
func ConvertToUpperCase(s string) string { ... }
func ValidateEmailAddress(email string) bool { ... }

// ✅ エクスポートされない関数（小文字開始）
func parseXMLContent(content string) error { ... }
func calculateTotalAmount(items []Item) float64 { ... }
func sendHTTPRequest(url string) error { ... }

型名

// ✅ エクスポートされる型
type DatabaseConnection struct { ... }
type HTTPServer struct { ... }
type UserAccountManager interface { ... }

// ✅ エクスポートされない型
type internalConfig struct { ... }
type requestHandler struct { ... }
type responseWriter struct { ... }

定数

// ✅ エクスポートされる定数
const MaxBufferSize = 1024
const DefaultTimeout = 30 * time.Second
const APIVersion = "v1"

// ✅ エクスポートされない定数
const maxRetries = 3
const defaultPort = 8080
const configFileName = "app.conf"

頭字語（Acronym）の扱い

Go言語では、頭字語は一般的に全て大文字または全て小文字で表記します：

// ✅ 正しい頭字語の使用
var URL string          // not Url
var HTTPClient *Client  // not HttpClient
var XMLParser *Parser   // not XmlParser
var userID int64        // not userId
var apiKey string       // not apiKey

// 複数の頭字語が連続する場合
var HTTPSProxy string   // not HttpsProxy
var XMLHTTPRequest      // not XmlHttpRequest

パッケージレベルでの一貫性

package main

import (
    "encoding/json"
    "net/http"
    "time"
)

// ✅ 一貫したスタイル
type WebServerConfig struct {
    ServerAddr    string        // エクスポート
    ReadTimeout   time.Duration // エクスポート
    WriteTimeout  time.Duration // エクスポート
    maxConnections int          // 非エクスポート
    enableLogging  bool         // 非エクスポート
}

func (w *WebServerConfig) StartServer() error { ... }    // エクスポート
func (w *WebServerConfig) stopServer() error { ... }     // 非エクスポート

Python から Go へ

# Python スタイル
def process_user_data(user_name, email_address):
    max_retry_count = 3
    is_valid_email = validate_email(email_address)

// Go スタイル
func processUserData(userName, emailAddress string) {
    maxRetryCount := 3
    isValidEmail := validateEmail(emailAddress)
}

Java/C# から Go へ

// Java スタイル
public class DatabaseConnectionManager {
    private int maxConnectionPoolSize;
    
    public void establishConnection() { ... }
}

// Go スタイル
type DatabaseConnectionManager struct {
    maxConnectionPoolSize int  // 非エクスポート
}

func (d *DatabaseConnectionManager) EstablishConnection() { ... }  // エクスポート

gofmt と golint

Go言語のツールは MixedCaps 命名規則をサポートしています：

# gofmt は命名規則をチェックしませんが、フォーマットを統一
go fmt ./...

# golint は命名規則もチェック
golint ./...

# より厳密なチェック
golangci-lint run

まとめ

重要なポイント

アンダースコアは使わない（snake_case は避ける）
MixedCaps（パスカルケース）: エクスポートされる識別子
mixedCaps（キャメルケース）: エクスポートされない識別子
頭字語は統一: URL、HTTP、XML など
一貫性を保つ: プロジェクト全体で統一されたスタイル

利点

可読性: 単語の境界が明確
Go らしさ: Go コミュニティの標準に準拠
ツールサポート: 各種ツールとの親和性
エクスポート制御: 大文字/小文字でアクセス制御が明確

この命名規則を守ることで、Go言語らしい、保守しやすく読みやすいコードを書くことができます。

ポイント

Go言語では複数語の名前にアンダースコア（_）を使わず、代わりにMixedCaps（キャメルケース/パスカルケース）を使用します。

具体的な使い分け

MixedCaps（パスカルケース）: エクスポートされる識別子
- UserAccount, ParseHTML, MaxConnections
mixedCaps（キャメルケース）: エクスポートされない識別子
- userName, parseHTML, maxConnections

他言語との違い

言語	スタイル	例
Python	snake_case	`user_name`, `max_count`
C	snake_case	`max_buffer_size`
Go	mixedCaps	`userName`, `maxCount`
Java	camelCase	`userName`, `maxCount`

なぜこの規則が重要か

Go言語の可視性制御: 大文字/小文字がパッケージ外部への公開/非公開を決定するため、この命名規則は言語仕様と密接に関連しています。
エコシステムの統一: Go標準ライブラリから第三者パッケージまで、すべてがこの規則に従っているため、一貫性が保たれます。
ツールサポート: gofmt、golintなどのツールがこの規則を前提として動作します。

この簡潔な文章が、Go言語の命名規則全体をまとめる重要な原則を示していることがわかります。

おわりに

本日は、Go言語を効果的に使うためのガイドラインについて解説しました。

よっしー

何か質問や相談があれば、コメントをお願いします。また、エンジニア案件の相談にも随時対応していますので、お気軽にお問い合わせください。

それでは、また明日お会いしましょう(^^)