[C#] 프로퍼티(Property)

프로퍼티(Property)

외부에서 클래스 변수의 값을 할당할 때, 일반적으로 다음과 같이 원할 것이다.

• 변수의 값이 항상 올바르도록 강제하여, 할당된 값을 확실히 하길 바랄 경우
• 변수의 값이 변경되었을 때를 감지하여, 이 값에 영향을 받는 다른 함수나 동작을 실행하길 바랄 경우

 

해당 변수를 이곳저곳에서 가져가 사용하는 함수에서마다 조건들을 보는 것은 낭비일 수 있다.

프로퍼티가 이런 부분을 단 번에 해결해준다.

 

참고로 프로퍼티는 Unity의 인스펙터에서는 보이지 않는다.
보이게 하기 위해선 다른 추가 조치가 필요하다.

 

1. 정해진 범위 내의 값만 할당하기

• get: 외부에서 해당 프로퍼티에 접근하여 읽어야 하는 상황에서 호출된다.
• set: 외부에서 해당 프로퍼티에 접근하여 값을 할당해야 하는 상황에서 호출된다.

public class Example : MonoBehaviour
{
    public float HP // 프로퍼티
    {
        get
        {
            return _hp;
        }

        set
        {
            if (_hp >= 0f && _hp <= 100f)
            {
                _hp = value;
            }
        }
    }

    private float _hp; // 실제 내부 클래스 변수
}

 

2. 특정 이벤트 발생시키기

변수의 값이 변경됐다는 것을 알려주는 이벤트를 발생시키길 원한다면 프로퍼티를 통해서 구현이 가능하다.

public float HP
{
    get
    {
        return _hp;
    }

    set
    {
        if (_hp >= 0f && _hp <= 100f)
        {
            float preHp = _hp;
            _hp = value;

            if (!Mathf.Approximately(_hp, preHp))
                OnChangeValue();
        }
    }
}

 

3. 읽기 전용과 쓰기 전용 프로퍼티

읽기 전용이므로 값 할당이 불가능하다.

public class Example : MonoBehaviour
{
    private float _hp;
    public float HP // 읽기 전용
    {
        get
        {
            return _hp;
        }
    }
}

 

쓰기 전용이므로 읽기가 불가능하다.

public class Example : MonoBehaviour
{
    private float _hp;
    public float HP // 쓰기 전용
    {
        set
        {
            _hp = value;
        }
    }
}

 

외부에서는 읽기 전용이고 내부에서는 조건부 값 할당을 하고 싶을 경우에는 다음과 같이 쓸 수 있다.

public class Example : MonoBehaviour
{
    private float _hp;
    public float HP
    {
        get
        {
            return _hp;
        }

        private set
        {
            if (_hp >= 0f && _hp <= 100f)
            {
                _hp = value;
            }
        }
    }
}

 

4. 자동 구현 프로퍼티

조건이 있는 것이 아닌 단순히 변수 값 할당, 반환만 할 것이라면 자동 구현 프로퍼티가 편하다. 클래스 내부 변수에 할당, 반환이 아닌 프로퍼티 그 자체를 사용하는 것으로 get, set 접근자 안에 아무것도 쓰지 않으면 된다.

public class Example : MonoBehaviour
{
    public float HP { get; set; }  // 자동 구현 프로퍼티
}

class ExternalClass
{
    public void Function()
    {
        Example example = new Example();
        example.HP = 50f;
    }
}

// 1. 프로퍼티는 선언과 동시에 필드에 대한 초기화 가능
public float HP { get; set; } = 100f;

// 2. 클래스 객체를 생성할 때도 초기화 가능
Example example = new Example() { HP = 100f };

// 3. 무명 형식 지원
var example = new { HP = 100f }; // 단, 한번 값 할당하면 변경 불가

 

6. 초기화 전용 자동 구현 프로퍼티

기존에는 프로퍼티를 읽기 전용으로 선언하는 방법이 조금 불편했다. 생성자를 통해 필드를 초기화하고 그 필드에 접근하는 프로퍼티는 get 접근자만 갖도록 해야 했다.

class Monster
{
    private string name;
    private int hp;
    private int damage;

    public Monster(string name, int hp, int damage)
    {
        this.name = name;
        this.hp = hp;
        this.damage = damage;
    }

    public string Name { get { return name; } }
    public int HP { get { return hp; } }
    public int Damage { get { return damage; } }
}

 

이런 불편함은 자동 구현 프로퍼티에 init 접근자를 사용하면서 해결할 수 있다. set 접근자처럼 외부에서 프로퍼티를 변경할 수 있지만, 객체 초기화를 할 때만 가능하다는 점이 set 접근자와의 차이점이다.

class Monster
{
    public string Name { get; init; }
    public int HP { get; init; }
    public int Damage { get; init; }
}

 

객체 생성 후 해당 프로퍼티 내용을 수정하려고 하면 컴파일 오류가 발생하게 된다.

Monster monster = new Monster
{
    Name = "Slime",
    HP = 500,
    Damage = 10
};

monster.HP = 1000; // 컴파일 오류(초기화 후 수정 불가)

 

7. 인터페이스의 프로퍼티

인터페이스이므로 구현부는 갖지 않지만, 인터페이스를 상속받는 클래스에서는 반드시 프로퍼티를 구현해야 한다.

interface IMonster
{
    string Name // 자동 구현 프로퍼티와 똑같이 생겼지만 컴파일러가 자동으로 구현해주지 않음
    {
        get;
        set;
    }
}

class Monster : IMonster
{
    private string name;
    public string Name // 자식 클래스는 기반 인터페이스에 선언된 모든 프로퍼티를 구현해야 함
    {
        get {return name; }
        set {name = value; }
    }
}

 

8. 추상 클래스의 추상 프로퍼티(Abstract Property)

추상 클래스는 인터페이스처럼 구현되지 않은 프로퍼티인 추상 프로퍼티를 가질 수 있다.

abstract class AbstractMonster
{
    public int HP { get; set; } // 자동 구현 프로퍼티
    abstract string Name // 추상 프로퍼티
    {
        get;
        set;
    }
}

class Monster : AbstractMonster
{
    public override string Name // 추상 프로퍼티 재정의 강제
    {
        get;
        set;
    }
}