문서 메뉴

문서 홈Atlas App Services

튜토리얼: React Native용 Atlas Device Sync

이 페이지의 내용

  • 전제 조건
  • 템플릿 앱으로 시작하기
  • 템플릿 앱 설정
  • 설치 종속성
  • 앱 빌드
  • 앱 테스트
  • 템플릿 앱에 익숙해지기
  • Atlas 앱 서비스 앱
  • React Native 앱
  • 우선순위 수준 필드 추가
  • 우선순위 수준 정의
  • Item 데이터 모델 업데이트
  • 우선순위 선택기 추가
  • 앱 실행 및 테스트
  • 동기화 구독 업데이트
  • UI에 모드 토글 추가
  • 동기화 구독 업데이트
  • 앱 테스트
  • 다음 단계

예상 완료 시간: React Native 사용 경험에 따라 30 분

Realm React Native SDK와 @realm/react 를 사용할 수 있습니다. React Native로 모바일 애플리케이션을 빌드합니다. 이 튜토리얼에서는 Flexible Sync를 사용하는 자체 앱을 빌드하는 방법을 안내합니다.

이 튜토리얼에서는 미리 빌드된 타입스크립트 (Typescript) 템플릿 애플리케이션으로 시작하여 모든 것이 어떻게 조화를 이루는지 살펴보겠습니다.

이 앱은 미리 빌드된 템플릿으로, 작동 중인 React Native 애플리케이션(프론트엔드)과 해당 App Services App 구성 파일(백엔드)이 포함되어 있습니다.

템플릿 앱은 사용자가 다양한 작업을 통해 할 일(to-do) 목록을 관리할 수 있는 기본 애플리케이션입니다

  • 이메일/비밀번호 계정을 생성하고 앱에 로그인 및 로그아웃할 수 있습니다.

  • 작업을 만들고, 읽고, 업데이트하고, 삭제할 수 있습니다.

  • 사용자가 소유자가 아니더라도 모든 작업을 볼 수 있습니다.

템플릿 앱을 실행한 후에는 기존 Item 모델에 새 priority 필드를 추가하고 우선순위 범위 내의 항목만 표시하도록 유연한 동기화(Flexible Sync) 구독을 업데이트합니다. 이 예에서는 필요에 맞게 템플릿 앱을 조정하는 방법을 보여줍니다. 템플릿 앱의 현재 구조를 고려할 때 반드시 이렇게 변경할 필요는 없습니다.

템플릿 앱은 장치가 '오프라인 모드'에 있는 것을 시뮬레이션하는 토글도 제공합니다. 이 토글을 사용하면 인터넷에 연결되어 있지 않은 사용자를 에뮬레이션하여 Device Sync 기능을 빠르게 테스트할 수 있습니다. 그러나 프로덕션 애플리케이션에서는 이 토글을 제거할 가능성이 높습니다.

참고

빠른 시작 확인

안내된 튜토리얼을 따르지 않고 스스로 탐색하고 싶다면 React Native Quick Start 를 확인하세요. 여기에는 복사 가능한 코드 예제와 Atlas Device Sync로 React Native 앱을 설정하는 데 필요한 필수 정보가 포함되어 있습니다.

  • 이 튜토리얼을 시작하기 전에 React Native 개발을 위한 로컬 환경을 설정해야 합니다. 자세한 지침 은 개발 환경 설정을 참조하세요. React Native 문서에서 확인 가능합니다.

  • 이 튜토리얼은 템플릿 앱으로 시작합니다. 템플릿 앱을 만들려면 Atlas 계정, API 키 및 appservices가 필요합니다.

    • Atlas 계정 생성에 대한 자세한 내용은 Atlas 시작하기 설명서에서 확인할 수 있습니다. 이 튜토리얼을 사용하려면 무료 계층 클러스터가 있는 Atlas 계정이 필요합니다.

    • 또한 로그인하려는 MongoDB Cloud 계정에 대한 Atlas API 키 가 필요합니다. appservices를 사용하여 템플릿 앱을 만들려면 프로젝트 소유자 여야 합니다.

    • App Services 설치에 대해 자세히 알아보려면 App Services CLI 설치를 참조하세요. 설치 후 Atlas 프로젝트의 API 키를 사용하여 login 명령을 실행합니다.

이 튜토리얼은 react-native.todo.flex 라는 이름의 React Native SDK Flexible Sync Template 앱을 기반으로 합니다. 기본 앱으로 시작하여 그 위에 새로운 기능을 구축합니다.

템플릿 앱에 관한 자세한 사항은 템플릿 앱을 참조하십시오.

아직 Atlas 계정이 없는 경우 가입 하여 템플릿 앱을 배포하세요.

다음 단계에 따라 컴퓨터에서 템플릿 앱을 설치하여 실행할 수 있습니다:

1

터미널에서 클라이언트 코드가 포함된 디렉토리로 이동합니다. 앱 서비스 CLI를 사용하여 앱을 만든 경우 MyTutorialApp/frontend/react-native.todo.flex으로 이동합니다. 또는, 다운로드 또는 복제된 프로젝트의 루트로 이동합니다. 그런 다음 다음 명령을 실행하여 앱의 종속 항목을 설치하도록 탐색합니다.

npm install

iOS 기기 또는 시뮬레이터에서 앱을 빌드하고 실행하려면 CocoaPods를 사용하여 추가 iOS 종속성을 설치합니다.

cd ios
npx pod-install
2

이 시점에서는 iOS, Android 또는 둘 다에서 실행할 수 있는 완전한 기능을 갖춘 React Native 앱이 있어야 합니다.

오류가 발생하거나 기타 문제가 발생하는 경우 React Native 환경이 올바르게 설정되어 있는지 확인하세요. 공식 React Native 개발 환경 설정 을 참조하세요. 가이드. 개발 OS 및 대상 OS에 대한 모든 단계를 따르세요.

3

빌드가 완료되면, 시뮬레이터에서 작동하는 앱이 실행될 것입니다. 앱에서 새 계정을 등록하고 기능을 테스트합니다.

  • 목록에 몇 가지 주요 할 일(to-do) 항목을 추가합니다.

  • 하나 또는 두 개의 항목에 대한 확인란을 눌러 완료로 표시합니다.

  • 목록에서 삭제하려면 항목의 X를 누릅니다.

  • 앱에서 인터넷 연결을 토글하여 오프라인 모드를 시뮬레이션할 수 있습니다.

Atlas Cluster에 연결하고 todo.Item 컬렉션을 쿼리하면 앱 데이터를 볼 수 있습니다. React Native 앱이 오프라인 모드가 아닌 한 앱의 새 데이터와 변경 사항은 todo.Item 컬렉션에 자동으로 동기화됩니다.

Atlas 클러스터에 연결하는 방법을 알아보려면 데이터베이스 배포에 연결을 참조하세요.

마찬가지로 컬렉션의 모든 변경 사항은 React Native 앱에 자동으로 동기화됩니다. 클러스터에서 항목의 완료 상태를 변경해 보세요. 네트워크 연결이 가능할 때마다 React Native 앱이 새 값으로 자동 업데이트됩니다.

클러스터의 데이터 업데이트에 대해 자세히 알아보려면 문서 업데이트를 참조하세요.

이제 템플릿 앱이 실행되고 있으므로 코드를 자세히 살펴보고 우리가 작업 중인 내용을 살펴보겠습니다.

템플릿 앱에는 backend 디렉토리에 완전히 구성된 App Services App이 포함되어 있습니다. 클라이언트 애플리케이션이 연결하는 데 사용하는 realm_config.json에 고유한 app_id 값이 있습니다.

또한 다음과 같은 사전 정의된 구성이 포함되어 있습니다:

  • Atlas Cluster에 연결된 데이터 소스입니다.

  • React Native 앱의 Item 클래스와 일치하는 todo.Item 컬렉션의 데이터 모델입니다.

  • 사용자가 이메일과 비밀번호를 사용하여 앱에 등록하고 로그인할 수 있게 해주는 인증 제공자입니다.

  • 단일 세션 역할을 가진 유연한 동기화 구성으로, 사용자가 자신의 항목을 읽고 쓰고 다른 사용자의 항목을 볼 수 있습니다.

React Native 앱은 iOS 및 Android 기기에서 실행할 수 있는 완전히 구성된 모바일 클라이언트입니다.

앱은 @realm/react 라이브러리. 라이브러리에는 Atlas 백엔드 및 Realm 데이터베이스 작업을 간소화하는 React 후크 및 구성 요소가 포함되어 있습니다.

앱에는 일부 구성 파일 및 디렉토리가 포함되어 있지만 앱을 사용자 지정하려는 경우가 아니면 무시해도 됩니다. 이 튜토리얼에서는 source/ 디렉토리의 React 구성요소에 대해 잘 알고 있어야 합니다.

파일 이름
설명
ItemSchema.tsx
객체 데이터 모델을 포함한 Item 클래스입니다. AppWrapper.tsx에서 이 클래스를 가져와서 앱의 전체 Realm 스키마에 포함시킵니다.
AppWrapper.tsx
앱의 루트 구성 요소입니다. 래퍼 구성 요소로 작동하며 모든 @realm/react 공급자를 포함합니다. 여기에서 영역과 Atlas 백엔드에 대한 연결을 구성합니다.
App.tsx
대부분의 앱 기능은 이 구성 요소와 해당 하위 구성 요소에 포함되어 있습니다. @realm/react 재공자가 이 구성 요소를 둘러싸고 있기 때문에 이 구성 요소는 Atlas 백엔드 인스턴스,, 사용자 객체, Realm 데이터베이스와의 상호 작용에 액세스할수 있습니다.
WelcomeView.tsx
사용자가 앱을 처음 열 때 표시되는 사용자 등록 및 로그인 양식입니다.
ItemListView.tsx
사용자가 로그인한 후 상호작용하는 주요 할 일 목록 앱입니다. Item Realm 객체를 쿼리하고 리스트로 표시합니다. 또한 새 Item 객체를 생성하여 Realm에 저장하는 코드도 포함되어 있습니다.
CreateToDoPrompt.tsx
Item 객체에 대한 데이터를 입력할 수 있는 UI 양식입니다. 실제로 새 객체를 생성하는 코드는 ItemListView.tsx에 있습니다.
LogoutButton.tsx
인증된 사용자를 로그아웃하는 재사용 가능한 버튼입니다.
OfflineModeButton.tsx
현재 Realm syncSession을 일시 중지했다가 다시 시작하여 오프라인 모드를 시뮬레이션하는 재사용 가능한 버튼입니다.

이제 템플릿 앱에서 이미 제공되는 기능에 더 익숙해졌으므로 새 기능을 구현하는 코드를 작성해 보겠습니다.

이 튜토리얼에서는 Item 객체에 새 priority 속성을 추가하겠습니다. 이렇게 하면 할 일을 중요도에 따라 정리하고 가장 중요한 일에만 집중할 수 있습니다.

1

우리는 명시적으로 정해진 소수의 우선순위 레벨을 허용하고자 하며, 이 우선순위 레벨들을 손쉽게 정렬할 수 있도록 하길 원합니다. 이를 달성하기 위해, 헬퍼 함수를 사용하여 순서가 지정된 레벨 이름들을 우선순위를 나타내는 정수와 매핑하는 enum 객체를 정의합니다.

source/ItemSchema.tsx 의 가져오기(import)문 바로 아래에 다음 코드를 추가합니다.

function createEnum(arr) {
arr.forEach((p, i) => arr[p] = i);
return arr;
}
// Priority.High === 1
// Priority[Priority.High] === "High"
export const Priority = createEnum([
"Severe",
"High",
"Medium",
"Low",
])

enum 의 우선 순위 수준은 가장 중요한 것부터 가장 중요하지 않은 것까지 정렬됩니다. 각 레벨에 해당하는 인덱스 값은 가장 중요한 값인 Priority[0] 값에서 가장 중요하지 않은 Priority[3] 값까지 증가합니다. 즉, 우선순위 수준이 높을수록(더 중요함을 의미) 인덱스 값이 더 낮습니다.

2

이제 priority 필드의 가능한 값을 정의하는 enum이 생겼습니다. 그러나 여전히 Item 클래스에서 priority 필드를 정의해야 합니다.

코드에 source/ItemSchema.tsx 줄을 추가하여Item 데이터 모델에 priority 을 추가합니다:

source/ItemSchema.tsx
export class Item extends Realm.Object<Item> {
_id!: BSON.ObjectId;
isComplete!: boolean;
summary!: string;
owner_id!: string;
priority!: string;
static schema: Realm.ObjectSchema = {
name: 'Item',
primaryKey: '_id',
properties: {
// This allows us to automatically generate a unique _id for each Item
_id: {type: 'objectId', default: () => new BSON.ObjectId()},
// All todo items will default to incomplete
isComplete: {type: 'bool', default: false},
summary: 'string',
owner_id: 'string',
priority: {
// Store the index value of the Priority enum rather than the name
type: 'int',
default: Priority.High
},
},
};
}

참고

동기화가 되지 않는 이유

이 시점에서 앱 서비스 앱(App Services App)의 React Native Item 모델과 해당 스키마가 더 이상 일치하지 않습니다. 하지만 괜찮습니다.

영역 객체에 속성을 추가하는 것은 호환성이 손상되는 변경 사항이 아니므로 클라이언트를 재설정할 필요가 없습니다. 템플릿 앱에는 개발 모드가 활성화되어 있으므로 클라이언트 Realm 객체에 대한 변경 사항이 서버 측 스키마에 반영됩니다. 자세한 내용은 개발 모드데이터 모델 업데이트를 참조하세요.

3

이제 앱의 데이터 모델에 각 Item 객체에 대한 priority가 포함됩니다. 목록에 주요 할 일을 새로 추가할 때 우선순위 값을 선택할 수 있도록 앱 UI를 업데이트해 보겠습니다.

먼저 우선순위 선택기 컴포넌트를 구현하기 위해 외부 라이브러리를 설치합니다. 프로젝트 루트 내부의 터미널에서 다음을 실행합니다.

npm install @react-native-picker/picker

iOS용으로 빌드하는 경우 패키지를 설치한 후 관련 Cocoapod를 연결해야 합니다.

npx pod-install

설치 후 앱을 다시 빌드해야 할 수도 있습니다. 그러려면 프로젝트의 번들러를 중지한 다음 빌드 명령을 실행합니다:

이제 패키지가 완전히 설치되었으므로 선택기를 사용하도록 새로운 할 일 생성 프롬프트 구성 요소를 업데이트해 보겠습니다.

source/CreateToDoPrompt.tsx의 맨 위에 다음 가져오기를 추가합니다.

import {Picker} from '@react-native-picker/picker';
import {Priority} from './ItemSchema';

그런 다음 CreateToDoPrompt 컴포넌트를 수정합니다:

  • onSubmit() 의 props 정의에 priority를 추가합니다.

  • 상태 후크에서 priority를 추적합니다.

  • 상태를 가져온 Picker 구성 요소에 연결합니다.

  • priorityonSubmit() 핸들러에 전달합니다.

source/CreateToDoPrompt.tsx
type Props = {
onSubmit(args: {summary: string; priority: string;}): void;
};
export function CreateToDoPrompt(props: Props): React.ReactElement<Props> {
const {onSubmit} = props;
const [summary, setSummary] = useState('');
const [priority, setPriority] = useState(Priority.High);
return (
<View style={styles.modalWrapper}>
<Text h4 style={styles.addItemTitle}>
Add To-Do Item
</Text>
<Input
placeholder="What do you want to do?"
onChangeText={(text: string) => setSummary(text)}
autoCompleteType={undefined}
/>
<Picker
style={{width: '80%'}}
selectedValue={priority}
onValueChange={value => setPriority(value)}>
{Priority.map(priority => (
<Picker.Item
key={priority}
label={priority}
value={Priority[priority]}
/>
))}
</Picker>
<Button
title="Save"
buttonStyle={styles.saveButton}
onPress={() => onSubmit({summary, priority})}
/>
</View>
);
}

source/ItemListView.tsx에서 priority를 허용하고 사용할 수 있도록 createItem() 함수를 수정합니다.

source/ItemListView.tsx
const createItem = useCallback(
({summary, priority}: {summary: string, priority: string}) => {
realm.write(() => {
return new Item(realm, {
summary,
owner_id: user?.id,
priority
});
});
},
[realm, user],
);

그런 다음 priority 수준을 수락하고 createItem()으로 전달하도록 할 일 만들기 제출 핸들러를 수정합니다.

source/ItemListView.tsx
<CreateToDoPrompt
onSubmit={({summary, priority}) => {
setShowNewItemOverlay(false);
createItem({summary, priority});
}}
/>

마지막으로 목록 항목 템플릿을 수정하여 주요 할 일의 prioritysummary 앞에 렌더링합니다:

source/ItemListView.tsx
<ListItem
key={`${item._id}`}
bottomDivider
topDivider
hasTVPreferredFocus={undefined}
tvParallaxProperties={undefined}>
<Text>{item.priority}</Text>
<ListItem.Title style={styles.itemTitle}>
{item.summary}
</ListItem.Title>
<ListItem.Subtitle style={styles.itemSubtitle}>
{item.owner_id === user?.id ? '(mine)' : ''}
</ListItem.Subtitle>
<ListItem.CheckBox
checked={item.isComplete}
checkedColor={COLORS.primary}
iconType="material"
checkedIcon="check-box"
uncheckedIcon="check-box-outline-blank"
onPress={() => toggleItemIsComplete(item._id)}
/>
<Button
type="clear"
onPress={() => deleteItem(item._id)}
icon={
<Icon
type="material"
name="clear"
size={12}
color="#979797"
tvParallaxProperties={undefined}
/>
}
/>
</ListItem>
4

이제 앱에서 사용자가 새로운 주요 할 일 항목의 우선순위를 설정할 수 있어야 합니다.

앱을 다시 빌드하고 엽니다. 새 할 일 항목을 추가하여 우선 순위 수준을 선택할 수 있고 목록에 각 할 일의 우선 순위가 표시되는지 확인하십시오.

Device Sync 프로토콜은 각 동기화 클라이언트가 표준 RQL 쿼리를 사용하여 애플리케이션 데이터의 하위 집합을 선택한 다음 하위 집합을 구독하는 유연한 모델을 사용 이렇게 하면 하위 집합에 있는 모든 데이터의 최신 버전을 디바이스로 자동으로 가져오고 데이터 변경 사항을 디바이스 간에 동기화합니다.

예를 들어 사용 중인 템플릿 앱에는 현재 사용자가 소유한 항목에 대한 다음과 같은 기본 제공 구독이 있습니다.

source/ItemListView.tsx
realm.subscriptions.update(mutableSubs => {
mutableSubs.removeByName(itemSubscriptionName);
mutableSubs.add(
realm.objects(Item).filtered(`owner_id == "${user?.id}"`),
{name: ownItemsSubscriptionName},
);
});

런타임 중에 구독을 사용자 정의하여 앱에 필요한 데이터만 동기화할 수 있습니다. 기능을 추가하여 방법을 시연해 보겠습니다.

이 튜토리얼에서는 두 모드 사이를 전환할 수 있는 버튼을 추가하겠습니다. 하나는 앱이 모든 할 일 항목을 동기화하는 모드이고 다른 하나는 priority 가 높음 또는 심각함인 중요한 항목만 동기화하는 모드입니다.

1

먼저, ItemListView 컴포넌트에 useState() 훅을 추가하여 현재 모드를 추적합니다:

ItemListView.tsx
const [showImportantOnly, setShowImportantOnly] = useState(false);

그런 다음 할 일 목록 하단의 <ListItem> 뒤에 모드를 전환하는 새 버튼을 추가합니다.

source/ItemListView.tsx
<Button
title={showImportantOnly ? 'Show All' : 'Show Important Only'}
buttonStyle={{
...styles.addToDoButton,
backgroundColor: showImportantOnly ? '#00A35C' : '#FFC010',
}}
onPress={() => setShowImportantOnly(showImportantOnly => !showImportantOnly)}
/>
2

이 시점에서 앱은 UI에서 모드를 전환할 수 있지만 모드가 기능적으로 동일하도록 다른 작업을 수행하지 않았습니다. 현재 모드와 관련된 데이터만 동기화하도록 동기화 구독을 업데이트해 보겠습니다.

ItemListView컴포넌트의 첫 번째 useEffect 에서는 현재 모드를 확인하고 showImportantOnly 모드가 활성화되어 있다면 priority 필터를 추가하는 코드를 작성하세요.

source/ItemListView.tsx
useEffect(() => {
if (showAllItems) {
realm.subscriptions.update(mutableSubs => {
mutableSubs.removeByName(ownItemsSubscriptionName);
mutableSubs.add(realm.objects(Item), {name: itemSubscriptionName});
});
} else if (showImportantOnly) {
realm.subscriptions.update(mutableSubs => {
mutableSubs.removeByName(itemSubscriptionName);
mutableSubs.add(
realm.objects(Item).filtered(`owner_id == "${user?.id}" && priority <= 1`),
{name: ownItemsSubscriptionName},
);
});
} else {
realm.subscriptions.update(mutableSubs => {
mutableSubs.removeByName(itemSubscriptionName);
mutableSubs.add(
realm.objects(Item).filtered(`owner_id == "${user?.id}"`),
{name: ownItemsSubscriptionName},
);
});
}
}, [realm, user, showAllItems, showImportantOnly]);

중요

useEffect의 두 번째 인자에 있는 종속성 목록에 showImportantOnly를 추가하는 것을 잊지 마세요.

3

이제 앱이 현재 모드에 따라 동기화 구독을 수정하도록 설정되었습니다.

앱을 다시 빌드하고 실행하여 모든 것이 작동하는지 확인합니다. 주요 할 일(to-do) 항목을 생성하고, 완료하며, 삭제할 수 있어야 하고, 모든 항목과 중요한 항목만을 토글하여 볼 수 있는 기능이 포함되어야 합니다.

참고

피드백 공유

어떻게 진행되었나요? 페이지 오른쪽 하단에 있는 피드백 공유 탭을 통해 이 튜토리얼이 도움이 되었는지, 문제가 있었다면 어떤 것인지 알려주세요.

← 튜토리얼: Kotlin용 Atlas Device Sync