go sync.Once实现高效单例模式详解

目录
  • 1. 简介
  • 2. 基本实现
    • 2.1 单例模式定义
    • 2.2 sync.Once实现单例模式
    • 2.3 其他方式实现单例模式
      • 2.3.1 全局变量定义时赋值,实现单例模式
      • 2.3.2 init 函数实现单例模式
      • 2.3.3 使用互斥锁实现单例模式
    • 2.4 使用sync.Once实现单例模式的优点
    • 2.5 sync.Once和init方法适用场景
  • 3. gin中单例模式的使用
    • 3.1 背景
    • 3.2 具体实现
    • 3.3 sync.Once实现单例的好处
  • 4.总结

1. 简介

本文介绍使用sync.Once来实现单例模式,包括单例模式的定义,以及使用sync.Once实现单例模式的示例,同时也比较了其他单例模式的实现。最后以一个开源框架中使用sync.Once实现单例模式的例子来作为结尾。

2. 基本实现

2.1 单例模式定义

单例模式是一种创建型设计模式,它保证一个类只有一个实例,并提供一个全局访问点来访问这个实例。在整个应用程序中,所有对于这个类的访问都将返回同一个实例对象。

2.2 sync.Once实现单例模式

下面是一个简单的示例代码,使用 sync.Once 实现单例模式:

 package singleton
 import "sync"
 type singleton struct {
     // 单例对象的状态
 }
 var (
     instance *singleton
     once     sync.Once
 )
 func GetInstance() *singleton {
     once.Do(func() {
         instance = &singleton{}
         // 初始化单例对象的状态
     })
     return instance
 }

在上面的示例代码中,我们定义了一个 singleton 结构体表示单例对象的状态,然后将它的实例作为一个包级别的变量 instance,并使用一个 once 变量来保证 GetInstance 函数只被执行一次。

GetInstance 函数中,我们使用 once.Do 方法来执行一个初始化单例对象。由于 once.Do 方法是基于原子操作实现的,因此可以保证并发安全,即使有多个协程同时调用 GetInstance 函数,最终也只会创建一个对象。

2.3 其他方式实现单例模式

2.3.1 全局变量定义时赋值,实现单例模式

在 Go 语言中,全局变量会在程序启动时自动初始化。因此,如果在定义全局变量时给它赋值,则对象的创建也会在程序启动时完成,可以通过此来实现单例模式,以下是一个示例代码:

type MySingleton struct {
    // 字段定义
}
var mySingletonInstance = &MySingleton{
    // 初始化字段
}
func GetMySingletonInstance() *MySingleton {
    return mySingletonInstance
}

在上面的代码中,我们定义了一个全局变量 mySingletonInstance 并在定义时进行了赋值,从而在程序启动时完成了对象的创建和初始化。在 GetMySingletonInstance 函数中,我们可以直接返回全局变量 mySingletonInstance,从而实现单例模式。

2.3.2 init 函数实现单例模式

在 Go 语言中,我们可以使用 init 函数来实现单例模式。init 函数是在包被加载时自动执行的函数,因此我们可以在其中创建并初始化单例对象,从而保证在程序启动时就完成对象的创建。以下是一个示例代码:

package main
type MySingleton struct {
    // 字段定义
}
var mySingletonInstance *MySingleton
func init() {
    mySingletonInstance = &MySingleton{
        // 初始化字段
    }
}
func GetMySingletonInstance() *MySingleton {
    return mySingletonInstance
}

在上面的代码中,我们定义了一个包级别的全局变量 mySingletonInstance,并在 init 函数中创建并初始化了该对象。在 GetMySingletonInstance 函数中,我们直接返回该全局变量,从而实现单例模式。

2.3.3 使用互斥锁实现单例模式

在 Go 语言中,可以只使用一个互斥锁来实现单例模式。下面是一个简单代码的演示:

var instance *MySingleton
var mu sync.Mutex
func GetMySingletonInstance() *MySingleton {
   mu.Lock()
   defer mu.Unlock()
   if instance == nil {
      instance = &MySingleton{
         // 初始化字段
      }
   }
   return instance
}

在上面的代码中,我们使用了一个全局变量instance来存储单例对象,并使用了一个互斥锁 mu 来保证对象的创建和初始化。具体地,我们在 GetMySingletonInstance 函数中首先加锁,然后判断 instance 是否已经被创建,如果未被创建,则创建并初始化对象。最后,我们释放锁并返回单例对象。

需要注意的是,在并发高的情况下,使用一个互斥锁来实现单例模式可能会导致性能问题。因为在一个 goroutine 获得锁并创建对象时,其他的 goroutine 都需要等待,这可能会导致程序变慢。

2.4 使用sync.Once实现单例模式的优点

相对于init 方法和使用全局变量定义赋值单例模式的实现,sync.Once 实现单例模式可以实现延迟初始化,即在第一次使用单例对象时才进行创建和初始化。这可以避免在程序启动时就进行对象的创建和初始化,以及可能造成的资源的浪费。

而相对于使用互斥锁实现单例模式,使用 sync.Once 实现单例模式的优点在于更为简单和高效。sync.Once提供了一个简单的接口,只需要传递一个初始化函数即可。相比互斥锁实现方式需要手动处理锁、判断等操作,使用起来更加方便。而且使用互斥锁实现单例模式需要在每次访问单例对象时进行加锁和解锁操作,这会增加额外的开销。而使用 sync.Once 实现单例模式则可以避免这些开销,只需要在第一次访问单例对象时进行一次初始化操作即可。

但是也不是说sync.Once便适合所有的场景,这个是需要具体情况具体分析的。下面说明sync.Onceinit方法,在哪些场景下使用init更好,在哪些场景下使用sync.Once更好。

2.5 sync.Once和init方法适用场景

对于init实现单例,比较适用于在程序启动时就需要初始化变量的场景。因为init函数是在程序运行前执行的,可以确保变量在程序运行时已经被初始化。

对于需要延迟初始化某些对象,对象被创建出来并不会被马上使用,或者可能用不到,例如创建数据库连接池等。这时候使用sync.Once就非常合适。它可以保证对象只被初始化一次,并且在需要使用时才会被创建,避免不必要的资源浪费。

3. gin中单例模式的使用

3.1 背景

这里首先需要介绍下gin.Engine, gin.Engine是Gin框架的核心组件,负责处理HTTP请求,路由请求到对应的处理器,处理器可以是中间件、控制器或处理HTTP响应等。每个gin.Engine实例都拥有自己的路由表、中间件栈和其他配置项,通过调用其方法可以注册路由、中间件、处理函数等。

一个HTTP服务器,只会存在一个对应的gin.Engine实例,其保存了路由映射规则等内容。

为了简化开发者Gin框架的使用,不需要用户创建gin.Engine实例,便能够完成路由的注册等操作,提高代码的可读性和可维护性,避免重复代码的出现。这里对于一些常用的功能,抽取出一些函数来使用,函数签名如下:

// ginS/gins.go
// 加载HTML模版文件
func LoadHTMLGlob(pattern string) {}
// 注册POST请求处理器
func POST(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {}
// 注册GET请求处理器
func GET(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {}
// 启动一个HTTP服务器
func Run(addr ...string) (err error) {}
// 等等...

接下来需要对这些函数来进行实现。

3.2 具体实现

首先从使用出发,这里使用POST方法/GET方法注册请求处理器,然后使用Run方法启动服务器:

func main() {
   // 注册url对应的处理器
   POST("/login", func(c *gin.Context) {})
   // 注册url对应的处理器
   GET("/hello", func(c *gin.Context) {})
   // 启动服务
   Run(":8080")
}

这里我们想要的效果,应该是调用Run方法启动服务后,往/login路径发送请求,此时应该执行我们注册的对应处理器,往/hello路径发送请求也是同理。

所以,这里POST方法,GET方法,Run方法应该都是对同一个gin.Engine 进行操作的,而不是各自使用各自的gin.Engine实例,亦或者每次调用就创建一个gin.Engine实例。这样子才能达到我们预想的效果。

所以,我们需要实现一个方法,获取gin.Engine实例,每次调用该方法都是获取到同一个实例,这个其实也就是单例的定义。然后POST方法,GET方法又或者是Run方法,调用该方法获取到gin.Engine实例,然后调用实例去调用对应的方法,完成url处理器的注册或者是服务的启动。这样子就能够保证是使用同一个gin.Engine实例了。具体实现如下:

// ginS/gins.go
import (
   "github.com/gin-gonic/gin"
)
var once sync.Once
var internalEngine *gin.Engine
func engine() *gin.Engine {
   once.Do(func() {
      internalEngine = gin.Default()
   })
   return internalEngine
}
// POST is a shortcut for router.Handle("POST", path, handle)
func POST(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {
   return engine().POST(relativePath, handlers...)
}
// GET is a shortcut for router.Handle("GET", path, handle)
func GET(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {
   return engine().GET(relativePath, handlers...)
}

这里engine() 方法使用了 sync.Once 实现单例模式,确保每次调用该方法返回的都是同一个 gin.Engine 实例。然后POST/GET/Run方法通过该方法获取到gin.Engine实例,然后调用实例中对应的方法来完成对应的功能,从而达到POST/GET/Run等方法都是使用同一个实例操作的效果。

3.3 sync.Once实现单例的好处

这里想要达到的目的,其实是GET/POST/Run等抽取出来的函数,使用同一个gin.Engine实例。

为了达到这个目的,我们其实可以在定义internalEngine 变量时,便对其进行赋值;或者是通init函数完成对internalEngine变量的赋值,其实都可以。

但是我们抽取出来的函数,用户并不一定使用,定义时便初始化或者在init方法中便完成了对变量的赋值,用户没使用的话,创建出来的gin.Engine实例没有实际用途,造成了不必要的资源的浪费。

而engine方法使用sync.Once实现了internalEngin的延迟初始化,只有在真正使用到internalEngine时,才会对其进行初始化,避免了不必要的资源的浪费。

这里其实也印证了上面我们所说的sync.Once的适用场景,对于不会马上使用的单例对象,此时可以使用sync.Once来实现。

4.总结

单例模式是一种常用的设计模式,用于保证一个类仅有一个实例。在单例模式中,常常使用互斥锁或者变量赋值的方式来实现单例。然而,使用sync.Once可以更方便地实现单例,同时也能够避免了不必要的资源浪费。当然,没有任何一种实现是适合所有场景的,我们需要根据具体场景具体分析。

以上就是go sync.Once实现高效单例模式详解的详细内容,更多关于sync.Once单例模式的资料请关注我们其它相关文章!

(0)

相关推荐

  • Golang基于sync.Once实现单例的操作代码

    目录 基于sync.Once实现单例 单例类型定义Driver 类Field conn once.Do(func() {}) 并发访问once.Do() 对外暴露方法Conn() 重新new(Driver)会发生什么? 在go里实现单例模式有多种方式: 基于lock 基于init函数 基于sync.Once 本文介绍基于sync.Once的方式来实现单例,熟练掌握这种模式,并理解其底层原理,对大部分人来讲已经完全够用了. 基于sync.Once实现单例 // 其他package也可见,在其他地方

  • Go语言并发编程 sync.Once

    sync.Once用于保证某个动作只被执行一次,可用于单例模式中,比如初始化配置.我们知道init()函数也只会执行一次,不过它是在main()函数之前执行,如果想要在代码执行过程中只运行某个动作一次,可以使用sync.Once,下面来介绍一下它的使用方法. 先来看下面的代码: package main import ( "fmt" "sync" ) func main() { var num = 6 var once sync.Once add_one := fu

  • go并发利器sync.Once使用示例详解

    目录 1. 简介 2. 基本使用 2.1 基本定义 2.2 使用方式 2.3 使用例子 3. 原理 4. 使用注意事项 4.1 不能将sync.Once作为函数局部变量 4.2 不能在once.Do中再次调用once.Do 4.3 需要对传入的函数进行错误处理 4.3.1 基本说明 4.3.2 未错误处理导致的问题 4.3.3 处理方式 5. 总结 1. 简介 本文主要介绍 Go 语言中的 Once 并发原语,包括 Once 的基本使用方法.原理和注意事项,从而对 Once 的使用有基本的了解.

  • 一文解析 Golang sync.Once 用法及原理

    目录 前言 1. 定位 2. 对外接口 3. 实战用法 3.1 初始化 3.2 单例模式 3.3 关闭channel 4. 原理 5. 避坑 前言 在此前一篇文章中我们了解了 Golang Mutex 原理解析,今天来看一个官方给出的 Mutex 应用场景:sync.Once. 1. 定位 Once is an object that will perform exactly one action. sync.Once 是 Go 标准库提供的使函数只执行一次的实现,常应用于单例模式,例如初始化配

  • Go并发编程之sync.Once使用实例详解

    目录 一.序 二. 源码分析 2.1结构体 2.2 接口 三. 使用场景案例 3.1 单例模式 3.2 加载配置文件示例 四.总结 五. 参考 一.序 单从库名大概就能猜出其作用.sync.Once使用起来很简单, 下面是一个简单的使用案例 package main import ( "fmt" "sync" ) func main() { var ( once sync.Once wg sync.WaitGroup ) for i := 0; i < 10;

  • PHP单例模式详解及实例代码

    PHP单例模式详解 单例模式的概念 单例模式是指整个应用中某个类只有一个对象实例的设计模式.具体来说,作为对象的创建方式,单例模式确保某一个类只有一个实例,而且自行实例化并向整个系统全局的提供这个实例.它不会创建实例副本,而是会向单例类内部存储的实例返回一个引用. 单例模式的特点 单例模式的主要特点是"三私一公": 需要一个保存类的唯一实例的私有静态成员变量 构造函数必须声明为私有的,防止外部程序new一个对象从而失去单例的意义 克隆函数必须声明为私有的,防止对象被克隆 必须提供一个访

  • 9种Java单例模式详解(推荐)

    单例模式的特点 一个类只允许产生一个实例化对象. 单例类构造方法私有化,不允许外部创建对象. 单例类向外提供静态方法,调用方法返回内部创建的实例化对象.  懒汉式(线程不安全) 其主要表现在单例类在外部需要创建实例化对象时再进行实例化,进而达到Lazy Loading 的效果. 通过静态方法 getSingleton() 和private 权限构造方法为创建一个实例化对象提供唯一的途径. 不足:未考虑到多线程的情况下可能会存在多个访问者同时访问,发生构造出多个对象的问题,所以在多线程下不可用这种

  • Python下简易的单例模式详解

    Python 下的单例模式 要点: 1.某个类只能有一个实例: 2.它必须自行创建这个实例: 3.它必须自行向整个系统提供这个实例 方法:重写new函数 应该考虑的情况: 1.这个单例的类可能继承了别的类 2.这个单例的类还有可能要接收参数来实例化 要点: 实例化的过程其实不是直接调用init的,首先是new分配一块空间来创建实例,再由init对这个实例进行初始化.我们无法阻止new和init的调用,我们只能是限制他们的内容,以此使他们能达到单例的目的 代码: class people(obje

  • Java开发中为什么要使用单例模式详解

    一.什么是单例模式? 单例设计模式(Singleton Design Pattern)理解起来非常简单.一个类只允许创建一个对象(或者实例),那这个类就是一个单例类,这种设计模式就叫作单例设计模式,简称单例模式. 二.实战案例一:处理资源访问冲突 我们先来看第一个例子.在这个例子中,我们自定义实现了一个往文件中打印日志的 Logger 类.具体的代码实现如下所示: public class Logger { private FileWriter writer; public Logger() {

  • Vue3父子组件传参有关sync修饰符的用法详解

    目录 单向数据流讲解 Vue2.x使用 定义事件的形式, 通知父组件修改 .sync 和 update: 的使用 父传子, 传递多个数据的简写 采用v-model简写(要求严格) Vue3.x使用 普通用法 简写 单向数据流讲解 单向数据流(堆可以修改,栈不可修改) 我们都知道, 父传子的数据, 是单向数据流,即子组件不能直接修改, 父组件传递过来的值 但实际上, 对于修改值, 真正是:基本数据类型不可修改,复杂数据类型不要修改引用地址(栈),它的值可以随便修改 Vue2.x使用 定义事件的形式

  • C++基于boost asio实现sync tcp server通信流程详解

    目录 一.功能介绍 二.string类型数据交互 2.1 程序源码 2.2 编译&&执行 2.3 程序执行结果 三.byte类型数据交互 3.1 程序源码 3.2 编译&&执行 3.3 程序执行结果 一.功能介绍   基于boost asio实现server端通信,采用one by one的同步处理方式,并且设置连接等待超时.下面给出了string和byte两种数据类型的通信方式,可覆盖基本通信场景需求. 二.string类型数据交互   规定server与client双方

  • C++设计模式之单例模式详解

    目录 单例模式:就是只有一个实例. 单例模式又分为两种基本的情形:饿汉式和懒汉式 如下是懒汉式单例类 小结: 继续看单例模式 总结 单例模式:就是只有一个实例. singleton pattern单例模式:确保某一个类在程序运行中只能生成一个实例,并提供一个访问它的全局访问点.这个类称为单例类.如一个工程中,数据库访问对象只有一个,电脑的鼠标只能连接一个,操作系统只能有一个窗口管理器等,这时可以考虑使用单例模式. 众所周知,c++中,类对象被创建时,编译系统为对象分配内存空间,并自动调用构造函数

  • java 设计模型之单例模式详解

    Singleton 模式的宗旨在于确保某个类只有一个实例,别且为之提供一个全局访问点.为了防止其他工作人员实例化我们的类, 可以为该类创建唯一一个构造器,并将构造器的可见设置为私有.值得注意的是,如果我们创建了其他的非私有的构造器,或者根本没有为该类提 供构造器,那么其他人员还是能实例化我们的类. 如果不希望提前创建单例对象,我们可以等到第一次使用该单例对象的时候在创建它,即 滞后初始化.滞后初始化单例对象有两个理由: 1.也许在静态初始化时间,你没有关于如何初始化单例对象的足够信息. 2.选择

  • IOS Swift3 四种单例模式详解及实例

    Swift3 单例模式 常见的有这么几种方法 第一种简单到爆的 final class Single: NSObject { static let shared = Single() private override init() {} } final关键字的作用是这个类或方法不希望被继承和重写 第二种 public extension DispatchQueue { private static var onceToken = [String]() public class func once

  • Java中单例模式详解

    单例模式概念: java中单例模式是一种常见的设计模式,单例模式分三种:懒汉式单例.饿汉式单例.登记式单例三种. 单例模式有一下特点: 1.单例类只能有一个实例. 2.单例类必须自己自己创建自己的唯一实例. 3.单例类必须给所有其他对象提供这一实例. 单例模式确保某个类只有一个实例,而且自行实例化并向整个系统提供这个实例.在计算机系统中,线程池.缓存.日志对象.对话框.打印机.显卡的驱动程序对象常被设计成单例.这些应用都或多或少具有资源管理器的功能.每台计算机可以有若干个打印机,但只能有一个Pr

随机推荐