单例设计模式

发布于2024-07-30

Singleton Design Pattern

单例设计模式是软件编程中最重要和最常用的设计模式之一。它确保类在应用程序运行时只有一个实例，并提供对该实例的全局访问点。在这篇文章中，我们将讨论 Singleton 的重要性，如何在 Golang 中实现它，以及它带来的好处，特别是在并发环境中。

什么是单例？

Singleton 是一种将类的实例限制为单个实例的设计模式。它在需要单点控制或单个共享资源的情况下特别有用，例如：

配置管理器，需要集中应用程序设置。
数据库连接池，必须有效管理有限数量的连接。
记录器，其中日志一致性至关重要。

为什么使用单例？

我将列出一些关于 Pattern 实现的更有意义的观点，同时也表明并非一切都是美好的，我们可能会遇到一些问题。

好处

全局一致性：保证应用程序的所有点都使用相同的实例，提供数据和行为的一致性。
访问控制：集中控制实例的创建和访问，方便对象生命周期的维护和管理。
资源效率：避免不必要的多个实例创建，节省内存和处理资源。

缺点

测试难度：单例会使编写单元测试变得更加困难，因为它们引入了需要管理的全局状态。
增加耦合：过度使用单例会导致组件之间的耦合更紧密，从而难以维护和发展应用程序。

实现单例

为了实现单例，我将使用 Golang。在这种语言中，我们必须特别注意并发性，以确保只创建一个实例，即使多个 goroutine 尝试同时访问该实例也是如此。

为了使我们的示例更接近现实世界，让我们为我们的应用程序创建一个记录器。记录器是应用程序中的常用工具，需要唯一以确保日志一致性。

1 - 定义结构

首先，我们定义我们想要拥有单个实例的结构。

package logger

import (
    "fmt"
    "sync"
)

type Logger struct {}

var loggerInstance *Logger

2 - 实现NewInstance函数

NewInstance函数负责返回Singleton结构的单个实例。我们使用互斥体来确保并发环境中的安全性，实现双重检查锁定以提高效率。

package logger

import (
    "fmt"
    "sync"
)

type Logger struct{}

var logger *Logger
var mtx = &sync.Mutex{}

func NewInstance() *Logger {
    if logger == nil {
        mtx.Lock()
        defer mtx.Unlock()
        if logger == nil {
            fmt.Println("Creating new Logger")
            logger = &Logger{}
        }
    } else {
        fmt.Println("Logger already created")
    }
    return logger
}

3 - 实现日志类型

日志工具总是有一些日志类型，例如Info仅显示信息，Error显示错误等等。这也是过滤我们想要在应用程序中显示的信息类型的一种方法。

因此，让我们创建一个方法来显示 Info 类型的日志。为此，我们将创建一个函数来接收日志消息并将其格式化为 INFO 格式。

package logger

import (
    "fmt"
    "sync"
    "time"
)

const (
    INFO    string = "INFO"
)

type Logger struct{}

var logger *Logger
var mtx = &sync.Mutex{}

func NewInstance() *Logger {
    if logger == nil {
        mtx.Lock()
        defer mtx.Unlock()
        if logger == nil {
            fmt.Println("Creating new logger")
            logger = &Logger{}
        }
    } else {
        fmt.Println("Logger already created")
    }
    return logger
}

func (l *Logger) Info(message string) {
    fmt.Printf("%s - %s: %s\n", time.Now().UTC().Format(time.RFC3339Nano), INFO, message)
}

4 - 使用记录器

要使用我们的新记录器，我们将在主包中实例化它并创建一个日志以查看此实现的工作原理。

package main

import (
    "playground-go/pkg/logger"
)

func main() {
    log := logger.NewInstance()
    log.Info("This is an example of log")
}

这是我们运行程序的结果：

Creating new logger
2024-07-03T19:34:57.609599Z - INFO: This is an example of log

如果我们想测试NewInstance是否真的保证只有一个实例在运行，我们可以进行以下测试。

package main

import (
    "fmt"
    "playground-go/pkg/logger"
)

func main() {
    log := logger.NewInstance()
    log.Info("This is an example of log")

    log2 := logger.NewInstance()
    log2.Info("This is another example of log")

    if log == log2 {
        fmt.Println("same instance")
    } else {
        fmt.Println("different instance")
    }
}

我们的日志已更改，现在我们可以看到我们阻止了新实例的创建：

Creating new logger
2024-07-03T19:45:19.603783Z - INFO: This is an example of log
Logger already created
2024-07-03T19:45:19.603793Z - INFO: This is another example of log
same instance