코드 리뷰: 데이터 위주의 프로그래밍(1)

동료가 새로운 프로젝트를 맡게되어 하던 일을 제가 이어 하게 되었습니다.

프로젝트 전반적인 내용은 알고 있는 상태였고 개발에 앞서 지금까지 작성한 코드를 리뷰하였습니다.

가장 눈에 띄는 부분은 클래스 데이터를 자동화하여 데이타베이스로 저장하는 구조였습니다.

클래스의 속성을 읽어와 자동으로 데이타베이스로 저장하는 SQL 구문을 작성하게 되어 있었습니다.

‘EntityFramework을 사용하면 되지’하는 사람도 있을 것 같습니다. 이 글은 코드 리뷰에 대한 것임을 미리 말씀드립니다.

var eqStructureProperties = typeof(Document.EQStructure).GetProperties();
for (int i = 0; i < eqStructureProperties.Length; i++)
{
    string sColumnName = eqStructureProperties[i].Name;
    if (sColumnName != "Entity")
    {
        object oValue = data.GetType().GetProperty(sColumnName).GetValue(data, null);

        sColumns += string.Format("[{0}],", sColumnName);
        if (Document._notStringColumns.Contains(sColumnName))
        {
            sValues += string.Format("{0},", oValue == null ? "" : oValue.ToString());
        }
        else
        {
            sValues += string.Format("'{0}',", oValue == null ? "" : oValue.ToString());
         }
    }
}

저는 위 코드에서 2가지 부분을 수정하고 싶었습니니다.

첫째는 클래스 속성들중에서 어떤 것들을 데이타베이스에 저장할지 결정하는 부분이었습니다. 위에서는 코드의 if문에서 그 일을 하고 있습니다.

if (sColumnName != "Entity")

둘째는 칼럼의 데이타 형을 결정하는 부분이었습니다. 문자열의 경우는 값을 ‘‘로 묶어줘야 하기 때문에 본래 코드에서는 문자형이 아닌 속성 이름을 리스트에 담아 관리하고 있었습니다.

if (Document._notStringColumns.Contains(sColumnName))

클래스에 속성을 추가할 때마다(작업을 하다보면 이런 일은 항상 발생하기 마련입니다.) 만일 추가하는 속성이 데이타베이스로 저장되지 않는 것이라면 SQL 구문을 생성하는 코드에 예외 처리를 해줘야 합니다. 전 이게 싫었습니다. 코드 두 곳을 수정해줘야 하니까 말이죠.

그래서 클래스에 속성을 추가할때 데이타베이스에 저장하는 것인지 여부를 설정하는 방법이 없을까 고민하였습니다.

해결책은 CustomAttribute였습니다. 데이타베이스에 저장할 속성에는 CustomAttribute를 추가하고 저장하는 코드에서 CustomAttribute를 가지는 속성만 데이타베이스로 저장하도록 코드를 작성하면 됩니다.

이렇게 해두면 나중에 클래스에 속성을 추가(CustomAttribute 설정은 필요에 따라 하면 됩니다.)만 하고 SQL 구문을 생성하는 코드는 수정할 필요가 없습니다.

public class EQStructureAttribute : System.Attribute
{
}

public class EQStructure : INotifyPropertyChanged
{
    public EQStructure()
    {
        this.ElevationSpacings = new BindingList<ElevationSpacing>();
    }

    [EQStructureAttribute]
    public string UID { get; set; }

    // Point
    [EQStructureAttribute]
    public double Point1X { get; set; }
    [EQStructureAttribute]
    public double Point1Y { get; set; }
    [EQStructureAttribute]
    public double Point2X { get; set; }
    [EQStructureAttribute]
    public double Point2Y { get; set; }
    [EQStructureAttribute]
    public double Point3X { get; set; }
    [EQStructureAttribute]
    public double Point3Y { get; set; }

System.Attribute를 상속받아 Custom Attribute를 정의하였습니다. 그리고 데이타베이스에 저장할 속성에 추가하였습니다.

그리고 SQL 구문을 생성하는 코드를 아래와 같이 수정하였습니다.

var props = typeof(Document.EQStructure).GetProperties();
foreach (var prop in props)
{
    if (!prop.CustomAttributes.Any()) continue;

    string sColumnName = prop.Name;
    ColumnList.Add($"[{sColumnName}]");

    object oValue = data.GetType().GetProperty(sColumnName).GetValue(data, null);
    if (Document._notStringColumns.Contains(sColumnName))
    {
        ValueList.Add($"'{(oValue == null ? "" : oValue.ToString())}'");
    }
    else
    {
        ValueList.Add($"{(oValue == null ? "" : oValue.ToString())}");
    }
}
if (sColumnName != "Entity")

구문이 아래와 같이 바뀌었습니다.

if (!prop.CustomAttributes.Any())

칼럼의 데이터 형에 관한 부분은 클래스 속성이 데이터 형을 가지고 있기 때문에 본래 코드와 같이 할 이유가 없었습니다.

전 데이터를 추가하는 것을 좋아하지 않습니다. 아니 싫어합니다.

새로 추가한 클래스 멤버, 데이터들은 항상 관리를 해줘야 하는데 관리 대상이 많아 질수록 프로그램 오류도 많아진다고 생각합니다.

if (Document._notStringColumns.Contains(sColumnName))

구문을 아래와 같이 바꾸었습니다.

if (!prop.PropertyType.Equals(typeof(String)))

왜 있어야 하는지 모를 Document._notStringColumns가 사라지니 마음속 한켠이 후련해집니다.

이렇게 리팩토링을 하니 가볍고 유연해진 코드가 되었습니다.