Prebuild

사용법

Prebuild는 다음 명령어를 실행하여 사용할 수 있습니다.

이 명령어는 android 및 ios 디렉토리를 생성하여 React 코드를 실행합니다. 생성된 디렉토리를 수동으로 수정하면 npx expo prebuild --clean을 실행할 때 변경 사항을 잃을 위험이 있습니다. 대신, 구성 플러그인을 생성하여 prebuild 동안 네이티브 프로젝트를 수정해야 합니다.

prebuild 시스템을 사용하는 이유는 pitch 섹션에 나열된 이유로 매우 권장되지만, 시스템은 완전히 선택적이며 언제든지 사용을 중지할 수 있습니다.

EAS Build와 함께 사용

프로젝트에 android 및 ios 디렉토리가 포함되어 있지 않으면, EAS Build는 컴파일 전에 이러한 네이티브 디렉토리를 생성하기 위해 Prebuild를 실행합니다. 이는 npx create-expo-app을 사용하여 생성된 모든 프로젝트의 기본 동작입니다.

android 및 ios 디렉토리가 있는 프로젝트의 경우, EAS Build는 네이티브 디렉토리의 변경 사항을 덮어쓰지 않기 위해 기본적으로 Prebuild를 실행하지 않습니다.

앱을 로컬에서 컴파일하여 문제를 해결하는 경우(npx expo prebuild, 또는 npx expo run:android 또는 npx expo run:ios 실행), 빌드 과정에서 새로운 네이티브 디렉토리를 생성하기 위해 EAS Build와 함께 Prebuild를 계속 사용할 수 있습니다. 이 경우, android 및 ios 디렉토리를 .gitignore 또는 .easignore 파일에 추가하세요:

Expo CLI 실행 명령어와 함께 사용

다음 명령어를 실행하여 로컬에서 네이티브 빌드를 수행할 수 있습니다.

네이티브 빌드 디렉토리가 없는 경우, 특정 플랫폼에서 npx expo prebuild가 한 번 실행됩니다. 이후 실행 명령어를 사용할 때마다 로컬 구성과 네이티브 코드가 새로 동기화되었는지 확인하려면 npx expo prebuild를 수동으로 실행해야 합니다.

플랫폼 지원

Prebuild는 현재 Android와 iOS를 지원합니다. 웹은 네이티브 프로젝트를 생성할 필요가 없기 때문에 지원되지 않습니다. 개별 플랫폼을 빌드하려면 --platform 플래그를 사용할 수 있습니다.

종속성

prebuild의 첫 번째 단계는 템플릿에서 새로운 네이티브 프로젝트를 초기화하는 것입니다. 각 Expo SDK 버전에는 템플릿이 있으며, 각 Expo SDK 버전은 특정 React 및 React Native 버전에 해당합니다. 프로젝트의 React 및 React Native 버전은 템플릿 package.json의 dependencies 필드에서 사용하는 버전과 동일하지 않으면 업데이트됩니다.

패키지 관리자

종속성이 변경되면, prebuild는 현재 프로젝트에서 사용되는 패키지 관리자를 사용하여 패키지를 다시 설치합니다( 이는 lockfile에서 추론됩니다). 특정 패키지 관리자를 강제로 지정하려면 --npm, --yarn, --pnpm 중 하나를 제공할 수 있습니다.

모든 설치를 건너뛰려면 --no-install 명령어를 사용하면 됩니다. 이는 생성 테스트를 빠르게 수행하는 데 유용합니다.

클린

--clean 플래그는 기존 네이티브 디렉토리를 삭제한 후 생성합니다.

--clean 플래그 없이 npx expo prebuild를 다시 실행하면 기존 파일 위에 변경 사항이 적용됩니다. 이는 처음부터 다시 생성하는 것보다 빠르지만, 일부 경우에는 동일한 결과를 생성하지 않을 수 있습니다. 예를 들어, 모든 구성 플러그인이 멱등성이 있는 것은 아닙니다. 프로젝트가 애플리케이션 코드에 정규 표현식 변경을 추가하는 것과 같은 많은 "위험한 수정"을 수행하는 경우, 때때로 예상치 못한 동작을 초래할 수 있습니다. 따라서 --clean 플래그를 사용하는 것이 가장 안전한 방법이며, 대부분의 경우 권장됩니다.

플래그의 파괴적인 특성 때문에, --clean 플래그를 사용할 때는 깨끗한 git 상태를 유지하도록 경고합니다. 이 프롬프트는 선택 사항이며 CI에서 만날 때는 건너뛰게 됩니다.

원하는 경우, 환경 변수 EXPO_NO_GIT_STATUS=1을 활성화하여 확인을 비활성화할 수 있습니다.

프롬프트의 목적은 관리 워크플로우 사용자가 프로젝트의 .gitignore에 android 및 ios 디렉토리를 추가하도록 유도하여 프로젝트가 항상 관리되도록 하는 것입니다. 그러나 이는 사용자 정의 구성 플러그인을 개발하는 것을 더 어렵게 만들 수 있으므로, 이 동작을 강제할 메커니즘을 도입하지 않았습니다.

개발자가 워크플로우 간에 자주 전환해야 하는 경우가 있습니다. 예를 들어, Xcode 및 Android Studio에서 네이티브로 사용자 정의 기능을 빌드한 후 해당 기능을 로컬 구성 플러그인으로 이동하고 싶을 수 있습니다.

템플릿

관리 워크플로우를 유지하면서 네이티브 폴더가 생성되는 방식을 사용자 정의하려면 구성 플러그인을 빌드하면 됩니다. 많은 구성 플러그인이 이미 다양한 수정을 위해 존재합니다. [인기 있는 플러그인 목록][https://docs.expo.dev/eas]을 확인하여 자세한 정보를 얻을 수 있습니다.

Prebuild는 구성 플러그인으로 수정하기 전에 템플릿 파일을 생성합니다. 템플릿 파일은 Expo SDK 버전에 기반하며 npm 패키지 expo-template-bare-minimum에서 가져옵니다. npx expo prebuild 명령어에 --template /path/to/template.tgz를 전달하여 사용할 템플릿을 변경할 수 있습니다. 그러나 @expo/prebuild-config의 기본 수정자가 템플릿 파일에 대해 일부 문서화되지 않은 가정을 하기 때문에, 사용자 정의 템플릿을 유지하는 것이 까다로울 수 있으므로 일반적으로 권장되지 않습니다.

부작용

npx expo prebuild는 android 및 ios 디렉토리를 생성하는 것 외에도 몇 가지 부작용을 수행합니다. 이러한 부작용을 제거하기 위해 작업이 진행 중입니다. 이상적으로는 npx expo prebuild를 실행하면 Android 및 iOS 프로젝트가 생성되고 나머지 프로젝트는 변경되지 않아야 합니다.

네이티브 폴더를 생성하는 것 외에도 prebuild는 다음과 같은 수정을 수행합니다.

1. package.json의 scripts 필드를 수정합니다.

2. package.json의 dependencies 필드를 수정합니다.

scripts 필드에 대한 편의 변경은 개발자가 prebuild 이전/이후에 앱 작업 방식을 변경하는 유일한 부작용입니다. 모든 다른 변경 사항은 그대로 두고 git에 커밋하여 prebuild를 실행할 때 diff를 최소화할 수 있습니다.

선택성

Prebuild는 완전히 선택 사항이며 Expo에서 제공하는 모든 도구 및 서비스와 잘 작동합니다. npx expo prebuild를 사용하지 않는 프로젝트를 bare workflow 로 지칭했습니다. 이는 prebuild처럼 수시로 네이티브 프로젝트를 생성하는 대신, 개발자가 네이티브 프로젝트에 직접 변경을 가하는 프로젝트를 의미합니다.

Expo에서 제공하는 모든 것(예: EAS, Expo CLI 및 Expo SDK의 라이브러리)은 bare workflow 를 완벽하게 지원하도록 구축되었습니다. 이는 npx expo prebuild를 사용하는 프로젝트를 지원하기 위한 최소 요구 사항입니다. 유일한 예외는 Expo Go 앱으로, 이는 bare workflow 프로젝트를 로드할 수 있지만, Expo Go 런타임에 존재하지 않는 네이티브 코드에 대한 JavaScript 대체를 제공하는 경우에만 가능합니다.

Pitch

단일 네이티브 프로젝트 자체는 유지 관리, 확장 및 성장하기에 복잡합니다. 크로스 플랫폼 앱에서는 여러 네이티브 프로젝트를 유지 관리하고, 모든 타사 종속성에서 너무 뒤처지지 않도록 최신 운영 체제 릴리스와 함께 유지해야 합니다. 이 프로세스를 간소화하기 위해 선택적 Expo Prebuild 시스템을 만들었습니다. React Native 컨텍스트에서 네이티브 개발과 관련된 몇 가지 문제와 이에 대한 Expo Prebuild가 이러한 문제를 해결하는 이유를 아래에 나열했습니다.

반론

다음은 Expo Prebuild가 특정 프로젝트에 적합하지 않을 수 있는 몇 가지 이유입니다.

시용하는 주요 이유 정리

1. 네이티브 프로젝트 초기화 Prebuild는 네이티브 소스 코드를 자동으로 생성하여 Android 및 iOS 디렉토리를 만듭니다. 이를 통해 개발자는 별도의 초기 설정 없이 프로젝트를 바로 시작할 수 있습니다.

2. 일관된 프로젝트 설정 Prebuild는 프로젝트의 설정과 구성을 일관되게 유지합니다. 구성 플러그인을 사용하여 네이티브 프로젝트에 필요한 설정을 자동으로 추가하고, 수동으로 설정할 때 발생할 수 있는 실수를 줄여줍니다.

3. 간편한 업그레이드 Prebuild를 사용하면 네이티브 코드를 쉽게 업그레이드할 수 있습니다. package.json 파일에서 버전을 업데이트하고 Prebuild를 다시 실행하여 최신 버전의 네이티브 프로젝트를 생성할 수 있습니다. 이는 순수 JavaScript 애플리케이션을 업그레이드하는 것과 비슷한 방식입니다.

4. 크로스 플랫폼 설정 앱 아이콘, 이름, 스플래시 화면 등 크로스 플랫폼 설정을 단일 구성 파일에서 관리할 수 있습니다. 예를 들어, "icon": "./icon.png"와 같이 설정하면 모든 플랫폼에서 아이콘 생성이 자동으로 처리됩니다.

5. 종속성 관리 많은 네이티브 패키지는 추가 설정이 필요합니다. Prebuild는 이러한 설정을 자동으로 추가하여 복잡한 네이티브 컴파일 오류를 방지하고, 필요한 설정을 놓치는 실수를 줄입니다.

6. 네이티브 코드의 부작용 관리 Prebuild를 사용하면 구성 플러그인으로 네이티브 코드의 부작용을 관리할 수 있습니다. 이는 라이브러리 작성자가 자신의 라이브러리에 필요한 설정을 자동화하고, 이를 테스트할 수 있게 해줍니다. 결과적으로, 더 안정적이고 강력한 네이티브 코드 설정이 가능합니다.

7. 고아 코드 방지 패키지를 제거할 때 필요한 부작용을 자동으로 제거하여 고아 코드를 방지합니다. 이는 프로젝트를 깨끗하고 유지 관리하기 쉽게 만듭니다.

8. EAS Build와의 통합 Prebuild는 EAS Build와 통합되어 네이티브 디렉토리가 없는 프로젝트에서도 자동으로 네이티브 디렉토리를 생성합니다. 이는 빌드 프로세스를 간소화하고, 개발자가 빌드 환경에 집중할 수 있게 합니다.

Prebuild는 React Native와 Expo를 사용하는 프로젝트에서 네이티브 코드 관리를 단순화하고, 프로젝트 설정을 일관되게 유지하며, 업그레이드와 종속성 관리를 쉽게 만들어줍니다. 이를 통해 개발자는 네이티브 코드의 복잡성을 줄이고, 더 빠르고 안정적으로 개발을 진행할 수 있습니다.