SyncPlanLite

개요

• 이 프로젝트는 스마트간트 라이브러리 프로젝트입니다.
• Windows Form 컨트롤 라이브러리(.NET 8)로 생성하였습니다.

속성

• 솔루션 탐색기에서 프로젝트를 선택 후, 마우스 우클릭 > 속성 메뉴에서 확인할 수 있습니다.

빌드 - 조건부 컴파일 기호

• 작업 이동시 디버깅을 위해 조건부 컴파일 기호를 사용하였습니다.
• TRACE_ACTIVITY : 작업 이동시 전파되는 정보를 Console에 기록하는 코드가 있습니다.
• DEBUG_LOG : 작업 이동시 전파되는 정보를 log 파일에 기록하는 코드가 있습니다. 성능을 위해 배포시에는 포함하지 않고, 디버깅을 위해 사용합니다.
• AUTO_LOGIN : admin 자동 로그인 코드를 실행합니다.
• LOCAL_CONFIG : 로컬 설정 파일을 사용합니다.

빌드 전 이벤트

빌드 날짜

<Target Name="PreBuild" BeforeTargets="PreBuildEvent">
  <Exec Command="echo %25date%25 %25time%25 &gt; &quot;$(ProjectDir)\Properties\BuildDate.txt&quot;" />
</Target>

• SyncPlanLite 빌드 날짜를 form 제목으로 보여주고 있기 때문에 SyncPlanLite 빌드 전 현재 날짜를 BuildDate.txt에 저장합니다.
• 사용은 SyncPlanLite\Properties\Resources.resx 에 BuildDate.txt파일을 등록해서 코드에서 Properties.Resources.BuildDate 로 사용할 수 있습니다.

버전 업데이트

• 현재 젠킨스 빌드할때 AutoVersioning을 하고 있는데, 이때 솔루션 디렉토리에 version.json 가 생성됩니다. 이 파일의 버전 정보를 이용해서 간트 버전을 설정하도록 수정했습니다.
• csproj에서 간단한 Task를 등록해서 작업하려 했는데, json을 불러올때 Nuget 패키지(Newtonsoft.Json)을 사용해야 해서 SyncPlanLiteBuildTask 프로젝트를 생성하여 Task dll을 만들어 사용하도록 구현했습니다.
• 입력받은 path에 있는 json 파일에서 버전을 불러와서, Version String을 리턴합니다.

  [Required]
  public string JsonFilePath { get; set; }
  
  [Output]
  public string VersionString { get; set; }
  
  public override bool Execute()
  {
      try
      {
          string jsonText = File.ReadAllText(JsonFilePath);
          var jsonObject = JObject.Parse(jsonText);
          VersionString = $"{jsonObject["major"]}.{jsonObject["minor"]}.{jsonObject["patch"]}";
          Log.LogMessage(MessageImportance.High, VersionString);
          return true;
      }
      catch (Exception ex)
      {
          Log.LogErrorFromException(ex);
          return false;
      }
  }
  

• 사용시에는 csproj에서 Task를 등록하고, 결과 버전값으로 AssemblyVersion, FileVersion, Version, PackageVersion을 설정합니다.

  <UsingTask TaskName="VersionTask" AssemblyFile="..\SyncPlanLite\lib\SyncPlanLiteBuildTask.dll" />
  <Target Name="SetVersion" BeforeTargets="BeforeBuild" Condition=" '$(Configuration)' == 'Release' ">
    <VersionTask JsonFilePath="..\version.json">
      <Output TaskParameter="VersionString" PropertyName="AssemblyVersion" />
    </VersionTask>
    <PropertyGroup>
      <AssemblyVersion>$(AssemblyVersion)</AssemblyVersion>
      <FileVersion>$(AssemblyVersion)</FileVersion>
      <Version>$(AssemblyVersion)</Version>
      <PackageVersion>$(AssemblyVersion)</PackageVersion>
    </PropertyGroup>
  </Target>
  

NuGet 패키지

• Costura.Fody : 참조 dll을 포함하는 단일 dll파일로 만들어주는 패키지입니다.
• devExpress.Win.Design : DevExpress 컨트롤을 사용하기 위한 패키지입니다.
• HardwareInformation : 하드웨어 정보를 가져오는 패키지입니다. 오류보고시 사용합니다.
• IKVM : java 클래스를 사용할 수 있도록 해주는 패키지입니다. 웹 연결하지 않는 경우, 로그인 하기 위해 사용합니다.
• Microsoft.EntityFrameworkCore : Entity Framework Core를 사용하기 위한 패키지입니다.
  • Microsoft.EntityFrameworkCore.SqlServer : Entity Framework Core를 사용하여 SQL Server에 연결하기 위한 패키지입니다.
  • Microsoft.EntityFrameworkCore.Tools : Entity Framework Core를 사용하여 데이터베이스를 업데이트하기 위한 패키지입니다.
  • Microsoft.Extensions.Configuration
  • Oracle.EntityFrameworkCore : Entity Framework Core를 사용하여 Oracle에 연결하기 위한 패키지입니다.
  • Pomelo.EntityFrameworkCore.MySql : Entity Framework Core를 사용하여 MySQL에 연결하기 위한 패키지입니다.
• Microsoft.Web.WebView2 : WebView2 컨트롤을 사용하기 위한 패키지입니다. 하이브리드뷰 기능을 구현하기 위해 사용합니다.
• Newtonsoft.Json : json 데이터를 다루기 위한 패키지입니다.
• NLog : log를 기록하는 패키지입니다.
• RestSharp : REST API를 사용하기 위한 패키지입니다.
• WebSocketSharp : 엔진 서버 연결시 사용합니다.
• YamlDotNet : configuration yaml 파일을 읽어오기 위해 사용합니다.

Model 수정

• Model은 자동 생성되는 코드이기 때문에 직접 수정하지 않고 자동 생성하는 것을 권장하지만, CodeFirst 방식에서 DB로 업데이트하는 방법은 없기 때문에 약간의 수정이 필요합니다.

컬럼 추가

1. model > codefirst 폴더에서 컬럼이 추가된 테이블 cm_scenario.cs 파일을 열어 추가된 컬럼 segment를 정의합니다.

public partial class cm_scenario
{
  ...
  [StringLength(40)]
  public string segment { get; set; }
  ...
}

2. model > codefirst 폴더에서 SyncPlanContext 클래스의 OnModelCreating() 메서드에 다음과 같이 추가한다.

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
  modelBuilder.Entity<cm_scenario>()
      .Property(e => e.segment)
      .IsUnicode(false);
}

테이블 추가

1. SmartGantt 프로젝트의 model - codefirst 폴더에 ADO.NET 엔터티 데이터 모델을 추가합니다.
   
2. 모델 콘텐츠로 데이터베이스의 Code First를 선택합니다.
   
3. 추가하고자 하는 테이블이 위치한 DB를 선택하거나, 추가되어 있지 않다면 새 연결 버튼을 눌러 DB를 설정하여 줍니다. 중요 문자열 포함, App.config 연결 설정 저장 체크 해제한 후 다음 버튼을 선택합니다.
   
4. 추가하고자 하는 테이블을 체크한 후 마침 버튼을 선택하면 테이블명과 같은 클래스 파일과, CustomContext 클래스 파일이 자동 생성됩니다.
   
5. 자동생성된 context 파일에 OnModelCreating()메서드 내용을 복사하여 SyncPlanContext.cs의 메서드에 붙여넣고, 테이블 DBSet 변수도 복사합니다.

public SyncPlanContext(string name)
    : base($"name={name}Model")
{
  public virtual DbSet<cm_menu> cm_menu { get; set; }
  protected override void OnModelCreating(DbModelBuilder modelBuilder)
  {
    modelBuilder.Entity<cm_menu>>()
        .Property(e => e.id)
        .IsUnicode(false);
    ...
  }
}

6. CustomContext 클래스 파일은 삭제합니다.
7. not null 컬럼이지만 empty string을 저장해야 하는 컬럼인 경우 다음과 같이 수정합니다.

public partial class spp_operation_schedule
{
  [Required(AllowEmptyStrings = true)] //필수 컬럼이지만 empty string 허용
  [StringLength(40)]
  public string resource_code { get; set; }
}