✨ explicity declare

Author: yuanyu90221

.github/workflows/go.yml

@@ -0,0 +1,28 @@
+name: Go
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup go-task
+        uses: pnorton5432/setup-task@v1
+        with:
+          task-version: 3.29.1
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 'stable'
+          check-latest: true
+      - name: Task Build
+        run: make build
+      - name: Task Test
+        run: make test

.gitignore

@@ -0,0 +1,26 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env
+bin

Makefile

@@ -0,0 +1,14 @@
+.PHONY=build
+
+build:
+	@CGO_ENABLED=0 GOOS=linux go build -o bin/main cmd/*.go
+
+run: build
+	@./bin/main
+
+
+coverage:
+	@go test -v -cover ./...
+
+test:
+	@go test -v ./...

README.md

@@ -0,0 +1,92 @@
+# golang-explicity-check-interface-implementation
+
+這個 repository 主要用來示範。如何透過語法宣告的方式，讓 golang compiler 能夠在編譯時期就檢查出 struct 是否有實做介面所宣告 receiver 方法
+
+## 說明
+
+當今天需要針對很多種不同變量具有類似的介面，可以透過定義出一個介面共同規範出在 struct 的 receiver 方法。比如說處理檔案的方法，可能會有針對不同檔案比如說 csv 檔案類型， excel 檔案類型。這時為了之後在處理檔案這個方法可以方便擴充，可以針對要處理檔案的型別都需要具有一個處理檔案的方法 FileProcessor ，則可以透過介面定義到 fileprocessor.go 檔案如下:
+
+```golang
+type FileProcessor interface {
+	ParseLines(content string) ([]string, error)
+}
+```
+
+假設今天要實做一個處理 CSV 檔案的型別 CSVProcessor ，則我們可以實做 FileProcessor 介面定義的 Receiver到 csvprocessor.go 如下: 
+
+```golang
+type CSVProcessor struct{}
+
+func (c *CSVProcessor) ParseLines(content string) ([]string, error) {
+	lines := strings.Split(strings.TrimSpace(content), "\n")
+	return lines, nil
+}
+```
+
+這時在定義 ProcessFile 時，就可以根據不同的檔案。來傳入有實做 ParseLines 介面的型別了到 main.go 如下:
+
+```golang
+func ProcessFile(p FileProcessor, content string) ([]string, error) {
+	return p.ParseLines(content)
+}
+
+func main() {
+	csv := &CSVProcessor{}
+	csvResult, err := ProcessFile(csv, "name,age\nAlice,30\nBob,25")
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	fmt.Println(csvResult)
+}
+```
+
+然而，如果今天實做 CSVProcessor 型別的人，因為如果擴充去對 ParseLines 新增一個參數 amount 假設如下
+
+```golang
+func (c *CSVProcessor) ParseLines(content string, amount int) ([]string, error) {
+	lines := strings.SplitN(strings.TrimSpace(content), "\n", amount)
+	return lines, nil
+}
+```
+
+這時，會發現除了調用方會發現傳入的型別有錯，實做 CSVProcessor 型別的人，不會發現自己破壞了原本 ParseLines 的 Receiver 方法直到要運行時，才發現調用出錯。
+
+## 有一個方法可以讓這個錯誤很快在實做 CSVProcessor 型別檢查是否有實做了 FileProcessor 介面定義的 receiver 方法
+
+變更 csvprocessor.go 如下
+```golang
+type CSVProcessor struct{}
+
+var _ FileProcessor = (*CSVProcessor)(nil)
+
+func (c *CSVProcessor) ParseLines(content string, amount int) ([]string, error) {
+	lines := strings.SplitN(strings.TrimSpace(content), "\n", amount)
+	return lines, nil
+}
+```
+
+顯示如下:
+![compile-check-for-implementation](compile-check-for-implementation.png)
+
+語法解析
+```golang
+// 把 nil 轉換成 (*CSVProcessor) 型別指定給 FileProcessor 有時作介面的變數
+var _ FileProcessor = (*CSVProcessor)(nil)
+```
+
+加入這行之後，不會增加 compiler 之後的大小。但會強迫 compiler 去檢查 CSVProcessor 是否有時作 FileProcessor 介面定義的 receiver
+
+為了簡化說明，我把此作法稱為**顯性宣告**。
+
+## 顯性宣告的優點
+
+方便在實做的型別處，有編譯器檢查是否具實做介面定義的 receiver。 
+
+## 顯性宣告的缺點
+
+當介面足夠單純，不會有變更時。這個宣告顯的多餘一點。
+
+## 結論
+
+大部分時候，顯性宣告具有約束力的好處。

cmd/csvprocessor.go

@@ -0,0 +1,12 @@
+package main
+
+import "strings"
+
+type CSVProcessor struct{}
+
+var _ FileProcessor = (*CSVProcessor)(nil)
+
+func (c *CSVProcessor) ParseLines(content string) ([]string, error) {
+	lines := strings.Split(strings.TrimSpace(content), "\n")
+	return lines, nil
+}

cmd/csvprocessor_test.go

@@ -0,0 +1,37 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestCSVProcessor(t *testing.T) {
+	type args struct {
+		content string
+	}
+	var tests = []struct {
+		name    string
+		args    args
+		want    []string
+		wantErr error
+	}{
+		{
+			name: "simple test content",
+			args: args{
+				content: "name,age\nAlice,30\nBob,25",
+			},
+			want:    []string{"name,age", "Alice,30", "Bob,25"},
+			wantErr: nil,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			csv := &CSVProcessor{}
+			got, err := csv.ParseLines(tt.args.content)
+			assert.Equal(t, tt.wantErr, err)
+			assert.Equal(t, tt.want, got)
+		})
+	}
+}

cmd/fileprocessor.go

@@ -0,0 +1,5 @@
+package main
+
+type FileProcessor interface {
+	ParseLines(content string) ([]string, error)
+}

cmd/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+)
+
+func ProcessFile(p FileProcessor, content string) ([]string, error) {
+	return p.ParseLines(content)
+}
+
+func main() {
+	csv := &CSVProcessor{}
+	csvResult, err := ProcessFile(csv, "name,age\nAlice,30\nBob,25")
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	fmt.Println(csvResult)
+}

compile-check-for-implementation.png

@@ -0,0 +1,11 @@
+module github.com/leetcode-golang-classroom/golang-explicity-check-interface-implementation
+
+go 1.24.0
+
+require github.com/stretchr/testify v1.10.0
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)