백그라운드 처리 – 모던 안드로이드 (오준석의 생존코딩)
모던 안드로이드 #16 [백그라운드 처리]
https://www.youtube.com/watch?v=ZqhrZ8_3jlg&list=PLxTmPHxRH3VXHOBnaGQcbSGslbAjr8obc&index=17
- 상황별 백그라운드 처리를 위한 API는?
- 예제를 위한 뼈대 만들기
- AsyncTask를 대신할 Java 비동기 처리 솔루션
- LiveData 연동하여 UI 유지하기
- JobIntentService
- WorkManager
- WorkManager + ViewModel로 UI 동기화
1. 상황별 백그라운드 처리를 위한 API는?
모던 안드로이드
백그라운드 작업
Service
1. 오래 걸리는 처리
2. 백그라운드 작업시 사용
3. 기본적으로 UI Thread이며, 별도의 스레드 처리 // UI Thread 라서 UI에 영향을 줌
4. 다른 컴포넌트에 bind 할 수 있음
5. startService()로 시작, stopService()로 종료
6. 서비스 내에서 stopSelf()로 종료할 수 있음
IntentService
1. API 30 에서 deprecated -> JobIntentService
2. 기본 백그라운드 Thread로 동작
3. 작업이 순차적으로 수행 됨
4. 한 번에 하나의 작업만 수행 됨
JobIntentService
1. 기본적으로 IntentService와 비슷하게 동작함
2. enqueueWork()로 실행
3. onHandleWork() 에서 동작 처리
4. 제한시간이 10분임 (강제종료됨)
5. BIND_JOB_SERVICE 권한 필수
WorkManager
1. 대부분의 서비스로 할 수 있는 것을 대체 가능함
2. 오래 걸리는 작업을 Worker 로 구현
3. Worker를 기반으로 WorkRequest 를 작성
4. WorkRequest는 한 번만 수행과 반복 수행 등이 있음
5. 네트워크, 배터리 상태 등으로 트리거 가능
6. WAKE_LOCK을 자체 관리하므로 권한 추가로 OK
7. foreground 서비스로도 동작할 수 있음
백그라운드 솔루션
1. 즉각적인 실행
코틀린: 코루틴
자바: ExecutorService
WorkManager
2. 정확한 시간
AlarmManager
3. Deferred
WorkManager
정리
Service 는 기본 UI Thread 에서 돌아가고 사용하기 불편하므로 사용을 피한다.
IntentService(기본 백그라운드 Thread) deprecated -> JobIntentService (1~10분)
WorkManager
간단하고 짧은 작업 : WorkManager
긴 작업 : WorkManager (foreground)
기존 IntentService -> JobIntentServicde
긴 작업 + UI : Service bind + foreground
2. 예제를 위한 뼈대 만들기
3. AsyncTask를 대신할 Java 비동기 처리 솔루션
4. LiveData 연동하여 UI 유지하기
5. JobIntentService
6. WorkManager
7. WorkManager + ViewModel로 UI 동기화
package com.myhome.mymodernasyncapplication.repository;
import android.os.Handler;
import com.myhome.mymodernasyncapplication.R;
import com.myhome.mymodernasyncapplication.Result;
import java.util.concurrent.Executor;
public class NumberRepository {
private final Handler resultHandler;
private final Executor executor;
public NumberRepository(Handler resultHandler, Executor executor) {
this.resultHandler = resultHandler;
this.executor = executor;
}
public void longTask(final RepositoryCallback<Integer> callback) {
executor.execute(new Runnable() {
@Override
public void run() {
try {
int num = 0;
for (int i = 0; i < 100; i++) {
num++;
Result<Integer> result = new Result.Success<>(num);
notifyResult(result, callback);
Thread.sleep(100);
}
} catch (Exception e) {
Result<Integer> result = new Result.Error<>(e);
notifyResult(result, callback);
}
}
});
}
private void notifyResult(
final Result<Integer> result,
final RepositoryCallback<Integer> callback) {
resultHandler.post(new Runnable() {
@Override
public void run() {
callback.onComplete(result);
}
});
}
}
package com.myhome.mymodernasyncapplication.repository;
import com.myhome.mymodernasyncapplication.Result;
public interface RepositoryCallback<T> {
void onComplete(Result<T> result);
}
package com.myhome.mymodernasyncapplication.service;
import android.app.Notification;
import android.app.NotificationChannel;
import android.app.NotificationManager;
import android.content.Context;
import android.content.Intent;
import android.os.Build;
import androidx.annotation.NonNull;
import androidx.core.app.JobIntentService;
import androidx.core.app.NotificationCompat;
import androidx.core.content.ContextCompat;
import com.myhome.mymodernasyncapplication.R;
import com.myhome.mymodernasyncapplication.Result;
public class JobService extends JobIntentService {
private static final String CHANNEL_ID = "Job Channel";
private NotificationManager notificationManager;
public static void enqueueWork(@NonNull Context context, @NonNull Intent intent) {
JobIntentService.enqueueWork(context, JobService.class, 1000, intent);
}
@Override
protected void onHandleWork(@NonNull Intent intent) {
notificationManager = (NotificationManager)getSystemService(Context.NOTIFICATION_SERVICE);
createNotificationChannel();
try {
int num = 0;
for (int i = 0; i < 100; i++) {
num++;
showNotification(num);
Thread.sleep(100);
}
} catch (Exception e) {
}
}
private void createNotificationChannel() {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
CharSequence name = "job channel";
String description = "job description channel";
int importance = NotificationManager.IMPORTANCE_LOW;
NotificationChannel channel = new NotificationChannel(CHANNEL_ID, name, importance);
channel.setDescription(description);
notificationManager.createNotificationChannel(channel);
}
}
private void showNotification(int progress) {
Notification notification = new NotificationCompat.Builder(this, CHANNEL_ID)
.setSmallIcon(R.drawable.ic_launcher_foreground)
.setContentTitle("Job Service")
.setContentText("Job Text Service")
.setProgress(100, progress, false)
.setPriority(NotificationCompat.PRIORITY_LOW)
.build();
notificationManager.notify(2, notification);
}
}
package com.myhome.mymodernasyncapplication.ui;
import android.content.Context;
import android.os.Bundle;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.fragment.app.Fragment;
import androidx.lifecycle.Observer;
import androidx.lifecycle.ViewModelProvider;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.Toast;
import com.myhome.mymodernasyncapplication.MainViewModel;
import com.myhome.mymodernasyncapplication.R;
import com.myhome.mymodernasyncapplication.Result;
import com.myhome.mymodernasyncapplication.databinding.FragmentExecutorBinding;
import com.myhome.mymodernasyncapplication.repository.RepositoryCallback;
public class ExecutorFragment extends Fragment {
private MainViewModel viewModel;
private FragmentExecutorBinding binding;
private static final String TAG = ExecutorFragment.class.getSimpleName();
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fragment_executor, container, false);
binding = FragmentExecutorBinding.bind(view);
return binding.getRoot();
}
@Override
public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
super.onViewCreated(view, savedInstanceState);
viewModel = new ViewModelProvider(requireActivity()).get(MainViewModel.class);
viewModel.progressLiveData.observe(getViewLifecycleOwner(), progress -> binding.progress.setProgress(progress));
binding.button.setOnClickListener(view1 -> viewModel.longTask());
}
}
package com.myhome.mymodernasyncapplication.ui;
import android.content.Intent;
import android.os.Bundle;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.fragment.app.Fragment;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import com.myhome.mymodernasyncapplication.R;
import com.myhome.mymodernasyncapplication.databinding.FragmentJobBinding;
import com.myhome.mymodernasyncapplication.service.JobService;
public class JobFragment extends Fragment {
private FragmentJobBinding binding;
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fragment_job, container, false);
binding = FragmentJobBinding.bind(view);
return binding.getRoot();
}
@Override
public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
super.onViewCreated(view, savedInstanceState);
binding.button.setOnClickListener(v -> JobService.enqueueWork(requireContext(), new Intent()));
}
}
package com.myhome.mymodernasyncapplication.ui;
import android.content.Intent;
import android.os.Bundle;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.fragment.app.Fragment;
import androidx.lifecycle.ViewModelProvider;
import androidx.work.OneTimeWorkRequest;
import androidx.work.WorkManager;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import com.myhome.mymodernasyncapplication.R;
import com.myhome.mymodernasyncapplication.WorkManagerViewModel;
import com.myhome.mymodernasyncapplication.databinding.FragmentWorkBinding;
import com.myhome.mymodernasyncapplication.service.JobService;
import com.myhome.mymodernasyncapplication.worker.MyWorker;
public class WorkFragment extends Fragment {
private FragmentWorkBinding binding;
private WorkManagerViewModel viewModel;
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fragment_work, container, false);
binding = FragmentWorkBinding.bind(view);
return binding.getRoot();
}
@Override
public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
super.onViewCreated(view, savedInstanceState);
viewModel = new ViewModelProvider(requireActivity()).get(WorkManagerViewModel.class);
viewModel.progressLiveData.observe(getViewLifecycleOwner(), workInfo -> {
int progress = workInfo.getProgress().getInt("progress", 0);
binding.progress.setProgress(progress);
});
binding.button.setOnClickListener(v -> {
OneTimeWorkRequest request = new OneTimeWorkRequest
.Builder(MyWorker.class)
.build();
viewModel.startLongTask();
});
}
}
package com.myhome.mymodernasyncapplication.worker;
import android.app.Notification;
import android.app.NotificationChannel;
import android.app.NotificationManager;
import android.content.Context;
import android.os.Build;
import androidx.annotation.NonNull;
import androidx.core.app.NotificationCompat;
import androidx.work.Data;
import androidx.work.Worker;
import androidx.work.WorkerParameters;
import com.myhome.mymodernasyncapplication.R;
public class MyWorker extends Worker {
private static final String CHANNEL_ID = "Job Channel";
private NotificationManager notificationManager;
public MyWorker(@NonNull Context context, @NonNull WorkerParameters workerParams) {
super(context, workerParams);
}
@NonNull
@Override
public Result doWork() {
notificationManager = (NotificationManager) getApplicationContext().getSystemService(Context.NOTIFICATION_SERVICE);
createNotificationChannel();
try {
int num = 0;
for (int i = 0; i < 100; i++) {
num++;
Data data = new Data.Builder().putInt("progress", num).build();
setProgressAsync(data);
showNotification(num);
Thread.sleep(100);
}
} catch (Exception e) {
Result.failure();
}
return Result.success();
}
private void createNotificationChannel() {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
CharSequence name = "job channel";
String description = "job description channel";
int importance = NotificationManager.IMPORTANCE_LOW;
NotificationChannel channel = new NotificationChannel(CHANNEL_ID, name, importance);
channel.setDescription(description);
notificationManager.createNotificationChannel(channel);
}
}
private void showNotification(int progress) {
Notification notification = new NotificationCompat.Builder(getApplicationContext(), CHANNEL_ID)
.setSmallIcon(R.drawable.ic_launcher_foreground)
.setContentTitle("WorkManager long task")
.setProgress(100, progress, false)
.setPriority(NotificationCompat.PRIORITY_LOW)
.build();
notificationManager.notify(3, notification);
}
}
package com.myhome.mymodernasyncapplication;
import android.app.Application;
import android.os.Handler;
import android.os.Looper;
import androidx.core.os.HandlerCompat;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
public class App extends Application {
private static int NUMBER_OF_CORES = Runtime.getRuntime().availableProcessors();
ExecutorService executorService = Executors.newFixedThreadPool(NUMBER_OF_CORES);
Handler mainThreadHandler = HandlerCompat.createAsync(Looper.getMainLooper());
}
package com.myhome.mymodernasyncapplication;
import androidx.appcompat.app.AppCompatActivity;
import androidx.lifecycle.ViewModelProvider;
import androidx.navigation.NavController;
import androidx.navigation.NavHostController;
import androidx.navigation.Navigation;
import android.os.Bundle;
import android.view.View;
import com.myhome.mymodernasyncapplication.databinding.ActivityMainBinding;
public class MainActivity extends AppCompatActivity {
private ActivityMainBinding binding;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
binding = ActivityMainBinding.inflate(getLayoutInflater());
setContentView(binding.getRoot());
NavController navController = Navigation.findNavController(this, R.id.nav_host_fragment);
binding.buttonExecutor.setOnClickListener(view -> navController.navigate(R.id.executorFragment));
binding.buttonJob.setOnClickListener(view -> navController.navigate(R.id.jobFragment));
binding.buttonWork.setOnClickListener(view -> navController.navigate(R.id.workFragment));
}
}
package com.myhome.mymodernasyncapplication;
import android.app.Application;
import android.widget.Toast;
import androidx.annotation.NonNull;
import androidx.lifecycle.AndroidViewModel;
import androidx.lifecycle.MutableLiveData;
import com.myhome.mymodernasyncapplication.repository.NumberRepository;
import com.myhome.mymodernasyncapplication.repository.RepositoryCallback;
public class MainViewModel extends AndroidViewModel {
private final NumberRepository repository;
public MutableLiveData<Integer> progressLiveData = new MutableLiveData<>(0);
public MainViewModel(@NonNull Application application) {
super(application);
repository = new NumberRepository(
((App)application).mainThreadHandler,
((App)application).executorService
);
}
public void longTask() {
repository.longTask(result -> {
if (result instanceof Result.Success) {
progressLiveData.postValue(((Result.Success<Integer>) result).data);
} else if (result instanceof Result.Error) {
//Toast.makeText(requireActivity(), ((Result.Error<Integer>) result).exception.getMessage(), Toast.LENGTH_SHORT).show();
}
});
}
}
package com.myhome.mymodernasyncapplication;
public abstract class Result<T> {
private Result() {}
public static final class Success<T> extends Result<T> {
public T data;
public Success(T data) {
this.data = data;
}
}
public static final class Error<T> extends Result<T> {
public Exception exception;
public Error(Exception exception) {
this.exception = exception;
}
}
}
package com.myhome.mymodernasyncapplication;
import android.app.Application;
import androidx.annotation.NonNull;
import androidx.lifecycle.AndroidViewModel;
import androidx.lifecycle.LiveData;
import androidx.work.OneTimeWorkRequest;
import androidx.work.WorkInfo;
import androidx.work.WorkManager;
import com.myhome.mymodernasyncapplication.worker.MyWorker;
public class WorkManagerViewModel extends AndroidViewModel {
private WorkManager workManager;
private OneTimeWorkRequest request = new OneTimeWorkRequest
.Builder(MyWorker.class)
.build();
public LiveData<WorkInfo> progressLiveData;
public WorkManagerViewModel(@NonNull Application application) {
super(application);
workManager = WorkManager.getInstance(getApplication().getApplicationContext());
progressLiveData = workManager.getWorkInfoByIdLiveData(request.getId());
}
public void startLongTask() {
workManager.enqueue(request);
}
}
activity_main.xml
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".MainActivity">
<Button
android:id="@+id/button_executor"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="16dp"
android:layout_marginBottom="16dp"
android:text="Executor"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintStart_toStartOf="parent" />
<Button
android:id="@+id/button_job"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginEnd="16dp"
android:layout_marginBottom="16dp"
android:text="Job"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent" />
<!-- defaultNavHost = false 이면 히스토리 안 쌓임. -->
<fragment
android:id="@+id/nav_host_fragment"
android:name="androidx.navigation.fragment.NavHostFragment"
android:layout_width="match_parent"
android:layout_height="0dp"
app:defaultNavHost="false"
app:layout_constraintBottom_toTopOf="@+id/button_executor"
app:layout_constraintTop_toTopOf="parent"
app:navGraph="@navigation/nav_graph" />
<Button
android:id="@+id/button_work"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginBottom="16dp"
android:text="Work"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toStartOf="@+id/button_job"
app:layout_constraintStart_toEndOf="@+id/button_executor" />
</androidx.constraintlayout.widget.ConstraintLayout>
fragment_executor.xml
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".ui.ExecutorFragment">
<ProgressBar
android:id="@+id/progress"
style="?android:attr/progressBarStyleHorizontal"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:max="100"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />
<Button
android:id="@+id/button"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="16dp"
android:layout_marginBottom="16dp"
android:text="Start"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintStart_toStartOf="parent" />
<TextView
android:id="@+id/textView"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="16dp"
android:layout_marginTop="16dp"
android:text="Executor"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />
</androidx.constraintlayout.widget.ConstraintLayout>
fragment_job.xml
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".ui.JobFragment">
<ProgressBar
android:id="@+id/progress"
style="?android:attr/progressBarStyleHorizontal"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:max="100"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />
<Button
android:id="@+id/button"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="16dp"
android:layout_marginBottom="16dp"
android:text="Start"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintStart_toStartOf="parent" />
<TextView
android:id="@+id/textView"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="16dp"
android:layout_marginTop="16dp"
android:text="Job"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />
</androidx.constraintlayout.widget.ConstraintLayout>
fragment_work.xml
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".ui.WorkFragment">
<ProgressBar
android:id="@+id/progress"
style="?android:attr/progressBarStyleHorizontal"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:max="100"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />
<Button
android:id="@+id/button"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="16dp"
android:layout_marginBottom="16dp"
android:text="Start"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintStart_toStartOf="parent" />
<TextView
android:id="@+id/textView"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="16dp"
android:layout_marginTop="16dp"
android:text="WorkManager"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />
</androidx.constraintlayout.widget.ConstraintLayout>
navigation/nav_graph.xml
<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:id="@+id/nav_graph"
app:startDestination="@id/executorFragment">
<fragment
android:id="@+id/executorFragment"
android:name="com.myhome.mymodernasyncapplication.ui.ExecutorFragment"
android:label="fragment_executor"
tools:layout="@layout/fragment_executor" />
<fragment
android:id="@+id/jobFragment"
android:name="com.myhome.mymodernasyncapplication.ui.JobFragment"
android:label="fragment_job"
tools:layout="@layout/fragment_job" />
<fragment
android:id="@+id/workFragment"
android:name="com.myhome.mymodernasyncapplication.ui.WorkFragment"
android:label="fragment_work"
tools:layout="@layout/fragment_work" />
</navigation>
app 수준 build.gradle
dependencies {
implementation 'androidx.appcompat:appcompat:1.2.0'
implementation 'com.google.android.material:material:1.2.1'
implementation 'androidx.constraintlayout:constraintlayout:2.0.2'
implementation 'androidx.navigation:navigation-fragment:2.3.1'
implementation 'androidx.navigation:navigation-ui:2.3.1'
implementation 'androidx.legacy:legacy-support-v4:1.0.0'
testImplementation 'junit:junit:4.+'
androidTestImplementation 'androidx.test.ext:junit:1.1.2'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
def lifecycle_version = "2.2.0"
// ViewModel
implementation "androidx.lifecycle:lifecycle-viewmodel:$lifecycle_version"
// LiveData
implementation "androidx.lifecycle:lifecycle-livedata:$lifecycle_version"
def work_version = "2.4.0"
// (Java only)
implementation "androidx.work:work-runtime:$work_version"
}
AndroidManifest.xml
<application
android:name=".App"
...
<service android:name=".service.JobService" android:permission="android.permission.BIND_JOB_SERVICE" />
...
소스 다운로드
MyModernAsyncApplication