프로젝트 구조 관리 - 실험 도서관

프로젝트 디렉토리 구조 설정

Unity 기반의 로봇 시뮬레이션 프로젝트는 여러 리소스와 스크립트, 모델 파일들로 구성되기 때문에 명확한 디렉토리 구조 관리가 필요하다. 프로젝트가 복잡해질수록 각 파일이 어디에 위치하는지 명확하게 정의하지 않으면 프로젝트를 유지하고 관리하기 어려워진다. 이를 방지하기 위해 기본적으로 다음과 같은 디렉토리 구조를 유지하는 것이 좋다.

Assets/
    ├── Models/        # 3D 모델 파일
    ├── Scripts/       # C# 스크립트
    ├── Materials/     # 재질 파일
    ├── Prefabs/       # 미리 정의된 로봇 및 객체들
    ├── Scenes/        # 시뮬레이션 씬 파일
    ├── Textures/      # 텍스처 파일
    ├── Shaders/       # 셰이더 파일
    └── Resources/     # 추가적인 리소스들

이 디렉토리 구조는 유연하게 변경될 수 있지만, 이처럼 기본적인 카테고리로 구분하는 것이 프로젝트의 복잡도를 줄이고 유지보수성을 높인다.

Scripts 디렉토리의 세부 관리

Scripts 디렉토리는 로봇의 동작을 제어하는 핵심적인 코드가 위치하는 디렉토리이다. 각 스크립트 파일을 기능별로 분리하여 관리하는 것이 좋다. 예를 들어, 로봇의 모션 제어, 센서 데이터 처리, 경로 계획 등 각각의 기능을 별도의 스크립트 파일로 분리한다.

Assets/Scripts/
    ├── RobotControl/      # 로봇 제어 관련 스크립트
    ├── SensorProcessing/  # 센서 데이터 처리 스크립트
    ├── PathPlanning/      # 경로 계획 알고리즘 스크립트
    ├── UI/                # UI 관련 스크립트
    └── Utils/             # 공통으로 사용하는 유틸리티 스크립트

이렇게 스크립트를 세부적으로 분리하면 로봇의 제어, 경로 계획, 센서 데이터 처리 등의 기능을 독립적으로 개발 및 유지할 수 있다. 예를 들어, 로봇의 모션 제어 스크립트는 RobotControl 디렉토리에, 라이다(LiDAR) 센서 데이터를 처리하는 스크립트는 SensorProcessing 디렉토리에 두면, 로직을 보다 명확하게 분리할 수 있다.

클래스 파일 명명 규칙

각 스크립트 파일의 이름은 해당 스크립트가 하는 기능을 명확히 알 수 있도록 명명하는 것이 좋다. 예를 들어, 로봇의 휠 제어를 담당하는 스크립트는 WheelController.cs, 센서 데이터를 처리하는 스크립트는 LidarProcessor.cs와 같이 명명한다. 이렇게 하면 파일만 보고도 어떤 역할을 하는지 쉽게 파악할 수 있으며, 협업 시 가독성도 높아진다.

씬 파일 관리

Unity 프로젝트에서 중요한 또 하나의 요소는 씬 파일이다. 로봇의 다양한 환경에서의 동작을 테스트하기 위해 여러 씬을 생성하는 경우가 많다. 이러한 씬 파일들을 잘 관리하기 위해 Scenes 디렉토리 아래에 상황별로 씬 파일을 정리하는 것이 좋다.

Assets/Scenes/
    ├── IndoorScene.unity     # 실내 환경 테스트 씬
    ├── OutdoorScene.unity    # 실외 환경 테스트 씬
    └── FactoryScene.unity    # 공장 환경 테스트 씬

이와 같이 환경별로 씬 파일을 구분하면 테스트할 때마다 쉽게 원하는 씬을 찾아 사용할 수 있으며, 다양한 테스트 환경을 지원하는 시뮬레이션 프로젝트에서 매우 유용하다.

Prefabs의 사용과 관리

Prefabs는 Unity에서 미리 구성한 로봇이나 기타 객체들을 관리하는 중요한 요소이다. 각 로봇 모델이나 주변 환경에 사용할 객체들을 Prefab으로 만들어 두면, 이를 씬에 배치하고 재사용하는 것이 매우 편리해진다. 예를 들어, 로봇의 각 파트나 전체 로봇을 Prefab으로 만들어 두고, 씬에 여러 대의 로봇을 배치할 때 이를 간편하게 재사용할 수 있다.

Assets/Prefabs/
    ├── Robot/         # 로봇 관련 Prefab 파일
    ├── Environment/   # 환경 관련 Prefab 파일
    └── Sensors/       # 센서 관련 Prefab 파일

이러한 구조를 통해 복잡한 로봇 시뮬레이션 프로젝트에서 일관성 있는 객체 관리를 할 수 있으며, 성능 최적화에도 도움이 된다.

URDF 파일 관리

로봇 시뮬레이션에서 URDF(Universal Robot Description Format) 파일은 로봇의 운동학적 구조를 정의하는 중요한 요소이다. 이러한 URDF 파일들을 Models 디렉토리에 저장하고, 필요에 따라 Unity에서 임포트하여 로봇 모델로 변환한다.

Assets/Models/
    ├── URDF/              # URDF 파일
    └── UnityRobotModels/   # Unity에서 변환한 로봇 모델 파일

URDF 파일을 임포트한 후, 이를 Unity의 물리 엔진과 연동하여 로봇의 움직임을 시뮬레이션하게 된다.

Resources와 Textures의 관리

로봇 시뮬레이션 프로젝트에서 사용되는 다양한 리소스들(예: 텍스처, 오디오 파일, 추가적인 설정 파일 등)을 일관성 있게 관리하는 것도 중요하다. Unity는 Resources 폴더 내에 있는 파일을 런타임 중에 로드할 수 있기 때문에, 중요한 파일들은 Resources 폴더에 배치하고 이를 쉽게 액세스할 수 있도록 관리해야 한다.

Textures 디렉토리에는 로봇 모델이나 환경에 사용되는 텍스처 파일을 관리한다. 시뮬레이션의 현실감을 높이기 위해 고품질 텍스처를 사용하는 것이 중요하지만, 파일 크기가 커지면 프로젝트 성능에 영향을 줄 수 있기 때문에 적절한 해상도의 텍스처를 사용하는 것이 바람직한다.

Assets/
    ├── Resources/     # 런타임 중에 로드될 리소스
    ├── Textures/      # 로봇 및 환경의 텍스처 파일

리소스 파일 관리

리소스 파일에는 로봇의 설정 파일, 시뮬레이션 중 생성된 데이터 파일 등을 포함할 수 있다. 예를 들어, 로봇의 초기 설정 값을 Resources 폴더에 JSON 형식으로 저장해 두고, 시뮬레이션 시작 시 이를 로드하여 로봇의 초기 상태를 설정할 수 있다. 리소스 파일은 프로젝트에서 동적으로 사용되기 때문에, 그 내용이 프로젝트의 핵심 기능과 잘 맞도록 구조화해야 한다.

버전 관리의 중요성

로봇 시뮬레이션 프로젝트가 커지면서 다양한 기능들이 추가되고 변경될 수 있다. 특히 다수의 개발자들이 협업하는 환경에서는 버전 관리를 통해 각 개발자의 코드 변경 사항을 추적하는 것이 필수적이다. Unity 프로젝트에서 버전 관리를 효율적으로 하기 위해서는 Git이나 SVN 같은 버전 관리 도구를 사용하는 것이 일반적이다.

Git을 이용한 프로젝트 관리

Git은 가장 널리 사용되는 버전 관리 도구로, Unity 프로젝트에서 Git을 사용할 때 몇 가지 중요한 사항들을 고려해야 한다.

.gitignore 파일 설정: Unity 프로젝트에는 불필요한 임시 파일들이 많기 때문에 이를 Git에 포함시키지 않도록 .gitignore 파일을 설정해야 한다. .gitignore 파일에 포함시킬 항목은 일반적으로 Unity 프로젝트 생성 시 자동으로 생성되며, 추가적으로 불필요한 디렉토리나 파일을 수동으로 추가할 수도 있다.

# Unity 관련 항목
[Ll]ibrary/
[Tt]emp/
[Oo]bj/
[Bb]uild/
[Bb]uilds/

이와 같이 .gitignore 파일을 설정하면, 불필요한 임시 파일들이 버전 관리에 포함되지 않으므로 프로젝트의 크기를 줄이고 관리 효율성을 높일 수 있다.

버전 관리에서의 협업

다수의 개발자들이 협업하는 경우, Git의 브랜치 기능을 사용하여 각 개발자가 독립적으로 기능을 개발하고, 테스트를 거친 후 메인 브랜치에 병합하는 방식으로 프로젝트를 관리하는 것이 좋다. 이때 주의해야 할 점은 다음과 같다.

Feature 브랜치 전략: 새로운 기능을 개발할 때마다 별도의 브랜치를 생성하여 메인 브랜치와 분리된 상태에서 개발을 진행한다. 이를 통해 개발 중인 기능이 다른 기능에 영향을 미치지 않도록 한다.
Pull Request(PR): 개발이 완료된 후에는 PR을 생성하여 코드 리뷰를 거쳐 메인 브랜치에 병합하는 과정을 거친다. 코드 리뷰는 프로젝트의 품질을 높이는 중요한 과정으로, 특히 로봇 시뮬레이션과 같은 복잡한 프로젝트에서는 필수적이다.
병합 충돌 관리: 여러 개발자들이 동시에 작업하다 보면 코드 충돌이 발생할 수 있다. 이러한 충돌을 해결하기 위해서는 정기적으로 메인 브랜치의 변경 사항을 로컬 브랜치에 병합하여 충돌을 최소화하는 것이 좋다.

큰 파일 처리

로봇 시뮬레이션 프로젝트에서는 3D 모델 파일이나 텍스처 파일 등 용량이 큰 파일이 포함될 수 있다. 이런 경우 Git과 같은 버전 관리 도구에서 큰 파일의 처리에 주의해야 한다. Git의 경우 큰 파일을 관리하기 위해 Git Large File Storage (Git LFS)를 사용하는 것이 일반적이다.

Git LFS는 대용량 파일을 관리할 때 Git의 성능에 미치는 영향을 줄이기 위한 도구로, 대용량 바이너리 파일을 Git 저장소 내에서 효율적으로 관리할 수 있게 도와준다.

git lfs install
git lfs track "*.fbx"   # 예를 들어 .fbx 3D 모델 파일을 LFS로 추적
git add .gitattributes   # LFS 설정을 Git에 반영
git add <파일명>         # Git LFS로 처리할 파일 추가
git commit -m "Added large files"
git push origin main

이와 같이 Git LFS를 통해 대용량 파일을 효과적으로 관리하면 프로젝트의 크기가 커지더라도 버전 관리 성능을 유지할 수 있다.

프로젝트 버전 관리에서의 주의 사항

Unity 프로젝트는 여러 파일들이 서로 연관되어 작동하기 때문에, 특정 파일을 잘못 수정하거나 삭제하면 프로젝트가 정상적으로 작동하지 않을 수 있다. 따라서 버전 관리 시 다음과 같은 점들을 주의해야 한다.

메타 파일 관리

Unity 프로젝트에서 중요한 파일 중 하나는 .meta 파일이다. Unity는 프로젝트 내의 모든 에셋에 대해 메타 데이터를 저장하는데, 이 메타 파일들은 에셋의 고유 ID를 포함하고 있다. 메타 파일이 제대로 관리되지 않으면 Unity에서 에셋 간의 연결이 끊어지거나, 불필요한 파일 충돌이 발생할 수 있다.

Assets/
    ├── Scripts/               # 코드 파일
    ├── Scripts.meta           # 메타 파일
    └── Models/                # 모델 파일
        ├── Robot.fbx          # 로봇 모델 파일
        └── Robot.fbx.meta     # 로봇 모델에 대한 메타 파일

메타 파일을 Git에 포함시키는 것이 중요하다. 이 파일들을 포함하지 않으면, 협업 중에 다른 개발자들이 동일한 에셋을 사용할 때 문제를 일으킬 수 있다. Unity에서 메타 파일을 자동으로 생성하지만, 이를 Git에 포함하여 파일 간의 일관성을 유지하는 것이 필수적이다.

씬 병합 충돌 관리

씬 파일은 일반 텍스트 파일처럼 변경 사항을 병합하기 어려운 이진 데이터 파일로 저장된다. 이는 Git에서 두 개발자가 동시에 씬 파일을 수정했을 경우, 병합 충돌이 발생할 가능성을 높인다. 이러한 충돌을 방지하기 위해 씬 파일을 수정할 때는 다음의 전략을 사용할 수 있다.

씬 파일 잠금: Git과 같은 버전 관리 도구에서 씬 파일을 다른 개발자가 동시에 수정하지 않도록 잠금을 설정할 수 있다. 이를 통해 병합 충돌을 사전에 방지할 수 있다.
분할 작업: 씬 파일을 여러 개로 분리하여 각 씬 파일에 포함되는 요소들을 기능적으로 나누는 방법이다. 예를 들어, 한 씬 파일에 전체 환경과 객체를 모두 포함시키기보다는, 로봇에 관련된 요소와 환경에 관련된 요소를 분리하여 병합 충돌을 최소화할 수 있다.

협업 도구의 사용

대규모 로봇 시뮬레이션 프로젝트에서는 Git 외에도 협업을 효율적으로 하기 위한 다양한 도구들을 사용할 수 있다. 프로젝트의 진행 상황을 관리하고, 여러 개발자들이 동시에 작업할 수 있는 환경을 제공하는 도구들은 다음과 같다.

Jira와 같은 프로젝트 관리 도구

Jira는 애자일 개발을 위한 대표적인 프로젝트 관리 도구로, 작업 항목을 정의하고 이를 팀 내에서 할당 및 관리하는 데 유용하다. 특히 로봇 시뮬레이션과 같은 복잡한 프로젝트에서는 각 기능이나 이슈를 독립적인 작업 항목으로 정의하고, 이를 추적하여 진행 상황을 관리할 수 있다.

Confluence와 같은 문서화 도구

Confluence는 프로젝트 문서화를 위한 도구로, 개발 중 발생하는 다양한 정보를 중앙에서 관리할 수 있다. 특히 시뮬레이션 결과를 문서화하거나, 시뮬레이션 파라미터에 대한 정보를 저장하는 데 유용하다.

GitHub Actions를 통한 자동화

GitHub에서 제공하는 GitHub Actions는 CI/CD(Continuous Integration/Continuous Deployment) 파이프라인을 자동으로 실행할 수 있는 도구이다. 이를 통해 로봇 시뮬레이션 프로젝트에서 새로운 코드가 커밋될 때마다 빌드를 실행하고, 테스트를 자동으로 수행하는 작업을 설정할 수 있다.

GitHub Actions를 사용하여 설정할 수 있는 자동화 작업의 예시는 다음과 같다.

코드가 커밋되면 자동으로 Unity 프로젝트를 빌드
유닛 테스트 또는 시뮬레이션 테스트를 자동 실행
특정 브랜치에 푸시되면 배포 작업을 수행

이를 통해 로봇 시뮬레이션 프로젝트에서의 코드 품질을 보장하고, 버그를 사전에 방지할 수 있다.

Slack과 같은 실시간 커뮤니케이션 도구

Slack은 실시간으로 팀 간 소통을 할 수 있는 도구로, 개발 중 발생하는 문제를 신속히 공유하거나 코드 리뷰 요청, 중요한 업데이트 사항 등을 즉시 알리는 데 유용하다. Git과 같은 버전 관리 도구와 통합하여, 커밋이나 PR 발생 시 Slack에 알림을 보내는 방식으로 사용할 수 있다.

대규모 프로젝트 구조 관리 방안

프로젝트가 점점 커질수록, 코드와 리소스를 정리하고 유지하는 것이 중요하다. 대규모 프로젝트의 경우, 모듈화된 구조를 채택하여 기능별로 독립된 패키지로 관리할 수 있다.

모듈화된 패키지 관리

Unity에서는 프로젝트의 다양한 기능을 패키지로 분리할 수 있다. 이를 통해 프로젝트의 특정 기능이 다른 기능에 영향을 미치지 않도록 분리하여 개발할 수 있다.

Assets/
    ├── Core/           # 프로젝트의 핵심 기능
    ├── UI/             # 사용자 인터페이스 관련 기능
    ├── Physics/        # 물리 엔진 관련 기능
    ├── Simulation/     # 로봇 시뮬레이션 관련 기능
    ├── SensorData/     # 센서 데이터 처리 기능
    └── Networking/     # 네트워크 통신 기능

이와 같이 모듈화된 구조를 사용하면, 프로젝트가 커지더라도 각 모듈을 독립적으로 개발 및 유지보수할 수 있다. 또한, 특정 모듈에 문제가 발생했을 때 빠르게 그 부분을 찾고 수정할 수 있다.