feat: ⚡ add multipart file upload

yuanyu90221 · yuanyu90221 · commit d8b7fce9d301 · 2024-11-21T00:44:58.000+08:00
add multipart file upload
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -0,0 +1,26 @@
+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: task build
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,27 @@
+# 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
+uploads
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# golang-multipart-upload-sample
+
+This repository is for demo how to implement multipart file upload on golang
+
+## what is multipart upload?
+
+  A way to send large files by breaking them into smaller parts and encoding them into a single HTTP request.
+
+## Multipart upload vs regular upload
+
+* Encoding: Multipart MIME format vs plain binary/text
+* File size: Unlimited (chunks) vs request size limits.
+* Error handling: Retry chunks vs re-upload everything.
+* Flexibility: Supports extra metadata easily
diff --git a/Taskfile.yaml b/Taskfile.yaml
@@ -0,0 +1,37 @@
+version: '3'
+
+tasks:
+  default:
+    cmds:
+      - echo "This is task cmd"
+    silent: true
+  
+  build-server:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o bin/server cmd/server/main.go
+    silent: true
+  run-server:
+    cmds:
+      - ./bin/server
+    deps:
+      - build-server
+    silent: true
+  build-client:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o bin/client cmd/client/main.go
+    silent: true
+  run-client:
+    cmds:
+      - ./bin/client
+    deps:
+      - build-client
+    silent: true
+  coverage:
+    cmds:
+      - go test -v -cover ./...
+    silent: true
+  test:
+    cmds:
+      - go test -v ./...
+    silent: true
+  
diff --git a/client/index.html b/client/index.html
@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>File Upload</title>
+</head>
+<body>
+  <h1>Upload a File</h1>
+  <form action="http://localhost:8080/upload" method="post">
+    <!-- File Input-->
+    <label for="file">Choose a file</label>
+    <input type="file" id="file" name="file" required>
+    <br><br>
+    <!-- Submit Button -->
+    <button type="submit">Upload</button>
+  </form>
+  <br>
+  <br>
+  <h1>Upload a File - Multipart</h1>
+  <form action="http://localhost:8080/upload_multipart" method="post" enctype="multipart/form-data">
+    <!-- File Input-->
+    <label for="file">Choose a file</label>
+    <input type="file" id="file" name="file" required>
+    <br><br>
+    <!-- Submit Button -->
+    <button type="submit">Upload</button>
+  </form>
+</body>
+</html>
diff --git a/cmd/client/main.go b/cmd/client/main.go
@@ -0,0 +1,67 @@
+package main
+
+import (
+	"bytes"
+	"flag"
+	"fmt"
+	"io"
+	"log"
+	"mime/multipart"
+	"net/http"
+	"os"
+)
+
+func main() {
+	// Define a command-line flag for the file path
+	filePath := flag.String("file", "", "Path to the file upload (required)")
+	flag.Parse()
+
+	// Validate the file path
+	if *filePath == "" {
+		log.Fatal("Error: file path is required. Use the -file flag to specify the file")
+	}
+	// Open the file
+	file, err := os.Open(*filePath)
+	if err != nil {
+		log.Fatalf("Error opening file: %v", err)
+	}
+	defer file.Close()
+
+	// Create a buffer to store the request body
+	var buf bytes.Buffer
+	// Create a new multipart writer with the buffer
+	w := multipart.NewWriter(&buf)
+
+	// Create a new form field for the file
+	fw, err := w.CreateFormFile("file", file.Name())
+	if err != nil {
+		log.Fatalf("Error creating form file: %v", err)
+	}
+	// Copy the contents of the file to the form field
+	if _, err := io.Copy(fw, file); err != nil {
+		log.Fatalf("Error copying file content %v", err)
+	}
+
+	// Close the multipart writer to finalize the request
+	if err := w.Close(); err != nil {
+		log.Fatalf("Error closing multipart writer: %v", err)
+	}
+
+	// Create the HTTP request
+	req, err := http.NewRequest(http.MethodPost, "http://localhost:8080/upload_multipart", &buf)
+	if err != nil {
+		log.Fatalf("error creating request: %v", err)
+	}
+	req.Header.Set("Content-Type", w.FormDataContentType())
+
+	// Send the request
+	client := &http.Client{}
+	resp, err := client.Do(req)
+	if err != nil {
+		log.Fatalf("error sending request: %v", err)
+	}
+	defer resp.Body.Close()
+
+	// Print the response
+	fmt.Printf("Response status: %s\n", resp.Status)
+}
diff --git a/cmd/server/main.go b/cmd/server/main.go
@@ -0,0 +1,24 @@
+package main
+
+import (
+	"log"
+	"net/http"
+
+	"github.com/leetcode-golang-classroom/golang-multipart-upload-sample/internal/controller"
+)
+
+func HelloHandler(w http.ResponseWriter, r *http.Request) {
+	w.Write([]byte("Hello, World!"))
+}
+
+func main() {
+	addr := ":8080"
+
+	mux := http.NewServeMux()
+	mux.HandleFunc("GET /", HelloHandler)
+	mux.HandleFunc("POST /upload", controller.FileUpload)
+	mux.HandleFunc("POST /upload_multipart", controller.FileUploadMultipart)
+
+	log.Printf("server is listening at %s", addr)
+	log.Fatal(http.ListenAndServe(addr, mux))
+}
diff --git a/go.mod b/go.mod
@@ -0,0 +1,3 @@
+module github.com/leetcode-golang-classroom/golang-multipart-upload-sample
+
+go 1.22.4
diff --git a/internal/controller/file.go b/internal/controller/file.go
@@ -0,0 +1,103 @@
+package controller
+
+import (
+	"fmt"
+	"io"
+	"net/http"
+	"os"
+	"path/filepath"
+)
+
+func FileUpload(w http.ResponseWriter, r *http.Request) {
+	// Limit the size of the incoming request body to prevent abuse (e.g. 100MB)
+	const maxUploadSize = 100 << 20 // 100 MB
+	r.Body = http.MaxBytesReader(w, r.Body, maxUploadSize)
+
+	// Parse the form data
+	if err := r.ParseForm(); err != nil {
+		http.Error(w, "Error parsing form", http.StatusBadRequest)
+		return
+	}
+
+	// Get the filename
+	filename := r.FormValue("file")
+	if filename == "" {
+		http.Error(w, "Filename query parameter is required", http.StatusBadRequest)
+		return
+	}
+
+	// Define the destination path
+	uploadDir := "./uploads"
+	if err := os.MkdirAll(uploadDir, os.ModePerm); err != nil {
+		http.Error(w, "Failed to create upload directory: "+err.Error(), http.StatusInternalServerError)
+		return
+	}
+
+	destPath := filepath.Join(uploadDir, filename)
+	// Create the destination file
+	destFile, err := os.Create(destPath)
+	if err != nil {
+		http.Error(w, "failed to create destination file: "+err.Error(), http.StatusInternalServerError)
+		return
+	}
+	defer destFile.Close()
+
+	// Copy the raw body to the destination file
+	if _, err := io.Copy(destFile, r.Body); err != nil {
+		http.Error(w, "failed to save file:"+err.Error(), http.StatusInternalServerError)
+		return
+	}
+	// Respond with a success message
+	w.WriteHeader(http.StatusOK)
+	fmt.Fprintf(w, "File uploaded successfully: %s\n", filename)
+}
+
+func FileUploadMultipart(w http.ResponseWriter, r *http.Request) {
+	// Limit the size of the incoming request body to prevent abuse (e.g. 100MB)
+	const maxUploadSize = 100 << 20 // 100 MB
+	r.Body = http.MaxBytesReader(w, r.Body, maxUploadSize)
+
+	// Parse the multipart form
+	if err := r.ParseMultipartForm(10 << 20); err != nil {
+		http.Error(w, "failed to parse multipart form: "+err.Error(), http.StatusBadRequest)
+		return
+	}
+
+	// Retrieve the file from the form data
+	file, fileHeader, err := r.FormFile("file")
+	if err != nil {
+		http.Error(w, "unable to retrieve file from form:"+err.Error(), http.StatusBadRequest)
+		return
+	}
+	defer file.Close()
+
+	fmt.Printf("Uploaded File: %+v\n", fileHeader.Filename)
+	fmt.Printf("File Size: %+v\n", fileHeader.Size)
+	fmt.Printf("MIME Header: %+v\n", fileHeader.Header)
+
+	// Define the destination path
+	uploadDir := "./uploads"
+	if err := os.MkdirAll(uploadDir, os.ModePerm); err != nil {
+		http.Error(w, "failed to create upload directory: "+err.Error(), http.StatusInternalServerError)
+		return
+	}
+	destPath := filepath.Join(uploadDir, fileHeader.Filename)
+
+	// Create the destination file
+	destFile, err := os.Create(destPath)
+	if err != nil {
+		http.Error(w, "failed to create destination file: "+err.Error(), http.StatusInternalServerError)
+		return
+	}
+	defer destFile.Close()
+
+	// Copy the file's content to the destination file
+	if _, err := io.Copy(destFile, file); err != nil {
+		http.Error(w, "Failed to save file:"+err.Error(), http.StatusInternalServerError)
+		return
+	}
+
+	// Respond with a success message
+	w.WriteHeader(http.StatusOK)
+	fmt.Fprintf(w, "File uploaded successfully: %s\n", fileHeader.Filename)
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module github.com/leetcode-golang-classroom/golang-multipart-upload-sample`
	`2`	`+`
	`3`	`+go 1.22.4`