Unity skframework framework (XV), singleton singleton

Catalog

brief introduction

One 、 Common type single example

Two 、Mono Type singleton

---

brief introduction

Whether the singleton inherits by type MonoBehaviour Divided into two kinds , They are single cases of common type Singleton and Mono Type singleton MonoSingleton

One 、 Common type single example

Common type singletons are implemented through inheritance ISingleton Interface and implement OnInit event , This event is called automatically when the singleton is initialized .

Suppose we have a class A, It contains some properties and methods

using UnityEngine;

public class A
{
    public string StrValue { get; private set; }

    public void Func()
    {
        Debug.Log("Singleton Example.");
    }
}

By inheritance ISingleton Interface uses it as a singleton class

using UnityEngine;
using SK.Framework;

public class A : ISingleton
{
    public string StrValue { get; private set; }
    
    public void OnInit() 
    {
        StrValue = "Test";
    }

    public void Func()
    {
        Debug.Log("Singleton Example.");
    }
}

Invoke the sample ：

using UnityEngine;
using SK.Framework;

public class Example : MonoBehaviour
{
    private void Start()
    {
        string s = Singleton<A>.Instance.StrValue;
        Singleton<A>.Instance.Func();
        Debug.Log(s);
    }
}

Release of single case ：

// Case release sheet 
Singleton<A>.Dispose();

Two 、Mono Type singleton

Mono A singleton of type is inherited IMonoSingleton Interface to implement ,IsDontDestroyOnLoad Attribute is used to specify whether the singleton object is not destroyed .

using UnityEngine;
using SK.Framework;

public class A : MonoBehaviour, IMonoSingleton
{
    public string StrValue { get; private set; }

    public bool IsDontDestroyOnLoad { get { return true; } }

    public void OnInit() 
    {
        StrValue = "Test";
    }

    public void Func()
    {
        Debug.Log("Singleton Example.");
    }
}

Invoke the sample ：

using UnityEngine;
using SK.Framework;

public class Example : MonoBehaviour
{
    private void Start()
    {
        MonoSingleton<A>.Instance.Func();
    }
}

Release of single case ：

using UnityEngine;
using SK.Framework;

public class Example : MonoBehaviour
{
    private void Start()
    {
        MonoSingleton<A>.Instance.Func();
    }
    private void OnDestroy()
    {
        MonoSingleton<A>.Dispose();
    }
}