refactor!: 将 format 功能并入到 filename 参数中

Author: caixw

.github/workflows/go.yml

@@ -13,10 +13,10 @@ jobs:
 
     steps:
       - name: Check out code into the Go module directory
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up Go ${{ matrix.go }}
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@v6
         with:
           go-version: ${{ matrix.go }}
         id: go

example/main.go

@@ -48,7 +48,7 @@ func post(_ http.ResponseWriter, r *http.Request) {
 		log.Panic(err)
 	}
 
-	s, err := upload.NewLocalSaver(root, "", upload.Day, upload.Filename)
+	s, err := upload.NewLocalSaver(root, "", upload.FilenameAI)
 	if err != nil {
 		log.Panic(err)
 	}

save.go

@@ -14,7 +14,6 @@ import (
 	"strconv"
 	"strings"
 	"sync"
-	"time"
 )
 
 const presetMode = fs.ModePerm
@@ -41,20 +40,11 @@ type Deleter interface {
 	Delete(filename string) error
 }
 
-// 为 [New] 的参数 format 所允许的几种取值
-const (
-	None  = ""
-	Year  = "2006/"
-	Month = "2006/01/"
-	Day   = "2006/01/02/"
-)
-
 type localSaver struct {
-	root      *os.Root
-	baseURL   string
-	format    string
-	filenames func(fs fs.FS, filename, ext string) string
-	moveMux   sync.Mutex
+	root        *os.Root
+	baseURL     string
+	filenames   func(fs fs.FS, filename, ext string) string
+	filenameMux sync.Mutex
 }
 
 // NewLocalSaver 实现了一个基于本地文件系统的 [Saver] 接口
@@ -63,26 +53,20 @@ type localSaver struct {
 //
 // baseURL 为上传的文件生成访问地址的前缀；
 //
-// format 子目录的格式，只能是时间格式，取值只能是 [None]、[Year]、[Month] 和 [Day]；
-//
 // f 设置文件名的生成方式，要求文件在同一目录下具有唯一性，其类型如下：
 //
 //	func(dir fs.FS, filename, ext string) string
 //
-// dir 为所属的文件系统，filename 为文件名部分，可能包含部分目录名称，ext 为 filename 中的扩展名部分，
+// dir 为所属的文件系统，filename 用户上传的文件名，ext 为 filename 中的扩展名部分，
 // 返回值是修正后的 filename，实现者需要保证 filename 在 dir 下是唯一的，filename 的路径分隔符必须是 /，不随系统而改变。
-// 如果为空，则会采用 [Filename] 作为默认值；
-func NewLocalSaver(root *os.Root, baseURL, format string, f func(dir fs.FS, filename, ext string) string) (Deleter, error) {
+// 如果为空，则会采用 [FilenameAI] 作为默认值；
+func NewLocalSaver(root *os.Root, baseURL string, f func(dir fs.FS, filename, ext string) string) (Deleter, error) {
 	if root == nil {
 		panic("无效的参数 root")
 	}
 
-	if format != Year && format != Month && format != Day && format != None {
-		panic("无效的参数 format")
-	}
-
 	if f == nil {
-		f = Filename
+		f = FilenameAI
 	}
 
 	if baseURL != "" && baseURL[len(baseURL)-1] != '/' {
@@ -92,25 +76,21 @@ func NewLocalSaver(root *os.Root, baseURL, format string, f func(dir fs.FS, file
 	return &localSaver{
 		root:      root,
 		baseURL:   baseURL,
-		format:    format,
 		filenames: f,
 	}, nil
 }
 
 func (s *localSaver) Open(name string) (fs.File, error) { return s.root.Open(name) }
 
 func (s *localSaver) Save(f multipart.File, filename, ext string) (string, error) {
-	var relDir string
-	if s.format != None {
-		relDir = time.Now().Format(s.format)
-	}
-	if relDir != "" {
-		if err := s.root.MkdirAll(relDir, presetMode); err != nil { // 若路径不存在，则创建
-			return "", err
-		}
+	p := s.createFilename(filename, ext)
+
+	dir := path.Dir(p)
+	if err := s.root.MkdirAll(dir, presetMode); err != nil {
+		return "", err
 	}
 
-	p, destFile, err := s.createFile(relDir, filename, ext)
+	destFile, err := s.root.Create(p)
 	if err != nil {
 		return "", err
 	}
@@ -128,23 +108,19 @@ func (s *localSaver) Delete(filename string) error {
 	return s.root.Remove(filename)
 }
 
-// 主要是为了缩小 moveMux 的范围，只要保证在创建文件时是有效的就行。
-func (s *localSaver) createFile(relDir string, filename, ext string) (string, *os.File, error) {
-	s.moveMux.Lock()
-	defer s.moveMux.Unlock()
-
-	p := s.filenames(s.root.FS(), path.Join(relDir, filename), ext)
-	destFile, err := s.root.Create(p)
-	if err != nil {
-		return "", nil, err
-	}
-	return p, destFile, nil
+// 主要是为了缩小 filenameMux 的范围。
+func (s *localSaver) createFilename(filename, ext string) string {
+	s.filenameMux.Lock()
+	defer s.filenameMux.Unlock()
+	return s.filenames(s.root.FS(), filename, ext)
 }
 
-// Filename 在 dir 下为 s 生成唯一文件名
+// FilenameAI 在 dir 下为 s 生成唯一文件名
+//
+// 如果已经存在同名的文件，会在文件后以数字形式自增。
 //
 // s 包含了扩展名的文件名；
-func Filename(dir fs.FS, s, ext string) string {
+func FilenameAI(dir fs.FS, s, ext string) string {
 	base := strings.TrimSuffix(s, ext)
 
 	count := 1

save_test.go

@@ -16,12 +16,12 @@ var (
 	_ Deleter = &localSaver{}
 )
 
-func TestFilename(t *testing.T) {
+func TestFilenameAI(t *testing.T) {
 	a := assert.New(t, false)
 
-	f := Filename(os.DirFS("./testdir/"), "abc", "")
+	f := FilenameAI(os.DirFS("./testdir/"), "abc", "")
 	a.Equal(f, "abc")
 
-	f = Filename(os.DirFS("./"), "testdir/file.xml", ".xml")
+	f = FilenameAI(os.DirFS("./"), "testdir/file.xml", ".xml")
 	a.Equal(f, "testdir/file_1.xml")
 }

upload_test.go

@@ -11,9 +11,7 @@ import (
 	"mime/multipart"
 	"net/http"
 	"os"
-	"path"
 	"testing"
-	"time"
 
 	"github.com/issue9/assert/v4"
 )
@@ -25,7 +23,7 @@ func TestNew(t *testing.T) {
 	root, err := os.OpenRoot("./testdir")
 	a.NotError(err).NotNil(root)
 
-	s, err := NewLocalSaver(root, "", Day, Filename)
+	s, err := NewLocalSaver(root, "", FilenameAI)
 	a.NotError(err).NotNil(s)
 
 	u := New(s, 10*1024, "gif", ".png", ".GIF")
@@ -40,7 +38,7 @@ func TestUpload_isAllowExt(t *testing.T) {
 	root, err := os.OpenRoot("./testdir")
 	a.NotError(err).NotNil(root)
 
-	s, err := NewLocalSaver(root, "", Day, Filename)
+	s, err := NewLocalSaver(root, "", FilenameAI)
 	a.NotError(err).NotNil(s)
 
 	u := New(s, 10*1024, "gif", ".png", ".GIF")
@@ -60,7 +58,7 @@ func TestUpload_Do(t *testing.T) {
 	root, err := os.OpenRoot("./testdir")
 	a.NotError(err).NotNil(root)
 
-	s, err := NewLocalSaver(root, "https://example.com", Day, Filename)
+	s, err := NewLocalSaver(root, "https://example.com", FilenameAI)
 	a.NotError(err).NotNil(s)
 
 	u := New(s, 10*1024, "xml")
@@ -72,47 +70,31 @@ func TestUpload_Do(t *testing.T) {
 	a.NotError(err).NotNil(f)
 	defer f.Close()
 
-	body, ct := formData(a, filename)
+	// 上传一次
 
+	body, ct := formData(a, filename)
 	r, err := http.NewRequest(http.MethodPost, "/upload", body)
 	a.NotError(err).NotNil(r)
 	r.Header.Add("content-type", ct)
 
 	paths, err := u.Do("file", r)
 	a.NotError(err).
 		Length(paths, 1).
-		Equal(paths[0], "https://example.com/"+path.Join(time.Now().Format(Day), "file.xml"))
+		Equal(paths[0], "https://example.com/file.xml")
 
-	a.NotError(s.Delete(paths[0]))
-}
-
-func TestUpload_Do_None(t *testing.T) {
-	a := assert.New(t, false)
-	root, err := os.OpenRoot("./testdir")
-	a.NotError(err).NotNil(root)
-
-	s, err := NewLocalSaver(root, "https://example.com", None, Filename)
-	a.NotError(err).NotNil(s)
-
-	u := New(s, 10*1024, "xml")
-	a.NotError(err)
+		// 上传两次
 
-	filename := "./testdir/file.xml"
-
-	f, err := os.Open(filename)
-	a.NotError(err).NotNil(f)
-	defer f.Close()
-
-	body, ct := formData(a, filename)
-
-	r, err := http.NewRequest(http.MethodPost, "/upload", body)
+	body, ct = formData(a, filename)
+	r, err = http.NewRequest(http.MethodPost, "/upload", body)
 	a.NotError(err).NotNil(r)
 	r.Header.Add("content-type", ct)
 
-	paths, err := u.Do("file", r)
+	paths, err = u.Do("file", r)
 	a.NotError(err).
 		Length(paths, 1).
-		Equal(paths[0], "https://example.com/"+"file_1.xml") // 已经有 file.xml
+		Equal(paths[0], "https://example.com/file_1.xml")
+
+	a.NotError(s.Delete(paths[0]))
 }
 
 func formData(a *assert.Assertion, filename string) (*bytes.Buffer, string) {