Simple& Happy Dev

아래 그림에 보듯이 크게 카메라 권한을 가지고 (= 카메라 권한 필요) 플래시를 제어하는 방식과 카메라 권한 없이(카메라 권한 불필요) 플래시를 제어하는 방식으로 만들 수 있습니다.

방법1 (Camera API 이용하는 방법)
 - 장점: 안드로이드 구버전도 지원 가능, 구현 용이
 - 단점: 카메라 권한 필요, deprecated API, 느린 속도(but, 약간 개선 가능 - 이글의 마지막에 다룰 예정)

방법2 (Camera2 API 이용하는 방법)
- 장점: 최신 Camera API
- 단점: 카메라 권한 필요, 구현 복잡, 안드로이드 5.0 (API Level 21) 이상부터 가능

방법3 (Flashlight API 이용하는 방법)
- 장점: 카메라 권한 불필요, 구현 매우 용이, 빠른 속도
- 단점: 안드로이드 6.0 (API Level 23) 이상부터 가능

애초에 플래시는 카메라를 보조해주기 위해서 들어간 디바이스입니다.
그래서, 하드웨어적인 연결이나 소프트웨어적인 접근이 카메라에 가깝게 되어 있습니다.

그 결과 플래시를 제어하기 위해서는 카메라에 접근한 이후 카메라 파라미터로 플래시를 넘겨줘야 했습니다.

플래시가 동작하는 순서는 다음과 같습니다.

플래시 켜기: 카메라 객체의 인스턴스 생성 및 연결(open)
                    - 카메라 파라미터에 플래시 모드를 Torch로 설정(setFlashMode)
                    - 카메라 프리뷰 시작(startPreview)

플래시 끄기 방법1: 카메라 프리뷰 종료 (stopPreview) - 카메라 연결 해제 및 릴리즈(release)

플래시 끄기 방법2: 카메라 파라미터에 플래시 모드를 Off로 설정(setFlashMode)
                             (중요 - 추후 카메라 프리뷰 종료 및 카메라 인스턴스를 릴리즈하는 코드가 존재해야 합니다.)

화면 한가운데 별 모양 버튼을 하나 추가해서 이걸 누르면 플래시가 켜지도록 할 예정입니다. 그리고, 한 번 더 누르면 버튼이 토글되어서 꺼지도록 하겠습니다. 별 모양 버튼은 SDK에 내장된 리소스를 사용하시면 됩니다.

<?xml version="1.0" encoding="utf-8"?>
<android.support.constraint.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">

    <ImageButton
        android:id="@+id/ibFlashOnOff"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:src="@android:drawable/btn_star_big_off"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

</android.support.constraint.ConstraintLayout>

자바 (MainActivity.java)

onCreate에서는 기기에 플래시가 지원하지 않으면 메시지 출력하고 3초 후 종료하도록 처리(delayedFinish())하도록 만들어 줍니다.
또한 별 모양 버튼에 대한 클릭 리스너를 만들어서 클릭 시 플래시를 켜주거나 꺼주고(flashlight()), 플래시 켜짐 상태에 따른 별 모양 이미지(켜짐: 노란색 별, 꺼짐: 흰색 별)를 변경하도록 처리해줍니다.

package com.example.help.permissionflashlight;

import android.content.pm.PackageManager;
import android.hardware.Camera;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.view.View;
import android.widget.ImageButton;
import android.widget.Toast;

public class MainActivity extends AppCompatActivity {
    private static Camera mCamera = null;
    private ImageButton mImageButtonFlashOnOff;
    private boolean mFlashOn;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        if (!getPackageManager().hasSystemFeature(PackageManager.FEATURE_CAMERA_FLASH)) {
            Toast.makeText(getApplicationContext(), "There is no camera flash.\n The app will finish!", Toast.LENGTH_LONG).show();
            delayedFinish();
            return;
        }

        mImageButtonFlashOnOff = findViewById(R.id.ibFlashOnOff);
        mImageButtonFlashOnOff.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                flashlight();
                mImageButtonFlashOnOff.setImageResource(mFlashOn ? android.R.drawable.btn_star_big_on : android.R.drawable.btn_star_big_off);
            }
        });
    }

    private void delayedFinish() {
        new Handler().postDelayed(new Runnable() {
            @Override
            public void run() {
                finish();
            }
        }, 3000);
    }

초기에는 플래시가 꺼진 상태이고, 카메라 인스턴스인 mCamera가 null이므로 onCreate에 있던 flashlight()는 openCamera()에서 카메라 객체의 인스턴스를 생성 및 연결하고 문제가 없으면 true로 리턴하고, 이후 mFlashOn를 토글시켜주어서 켜진 상태(mFlashOn => true)로 세팅됩니다.

그리고, 플래시를 Torch 모드로 파라미터 세팅을 해주고, 프리뷰를 시작해주면 플래시가 켜지게 됩니다.

반대로 플래시가 켜진 상태에서 openCamera()에 진입하면 이전에 mCamera가 생성된 상태라서 별다른 처리 없이 true로 리턴되고 mFlashOn이 토글되면서 꺼진 상태(mFlashOn => false)로 세팅됩니다.

꺼진 상태일 경우 프리뷰를 종료하도록 하고, 카메라 인스턴스를 릴리즈해줍니다. 이후 mCamera는 꼭 null로 만들어주어야 이후 오동작을 하지 않게 됩니다.

    private boolean openCamera() {
        if (mCamera == null) {
            try {
                mCamera = Camera.open();
            } catch (RuntimeException e) {
                Toast.makeText(getApplicationContext(), "Camera open failed", Toast.LENGTH_LONG).show();
                e.printStackTrace();
                return false;
            }
        }
        return true;
    }

    private void flashlight() {
        if (openCamera()) {
            mFlashOn = !mFlashOn;

            if (mFlashOn) {
                Camera.Parameters params = mCamera.getParameters();
                params.setFlashMode(Camera.Parameters.FLASH_MODE_TORCH);

                mCamera.setParameters(params);
                mCamera.startPreview();

            } else {
                mCamera.stopPreview();
                mCamera.release();
                mCamera = null;
            }
        } else {
            delayedFinish();
        }
    }
}

여기까지 작업 후 실행을 하게 되면 아래와 같은 에러를 만나게 되고 openCamera()의 try ~ catch 에 의해 강제 종료(Force Close)가 되지 않고, 메시지 출력 후 openCamera() 리턴을 false로 해서 3초 후 종료할 수 있게 되어 있습니다. 

위와 같은 현상이 일어난 것은 에러 메시지의 내용과 같이 카메라 권한이 없는 상태에서 접근했기 때문에 발생한 것입니다.

메니페스트(AndroidManifest.xml)

카메라 권한을 추가하기 위해서는 아래와 같이 <uses-permission android:name="android.permission.CAMERA" />를 메니페스트 파일에 넣어주면 됩니다.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.help.permissionflashlight">

    <uses-permission android:name="android.permission.CAMERA" />

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

프로젝트 압축화일
PermissionFlashlight.zip

실행 결과

cf) 플래시 끄기 방법2

플래시 끄기 1번의 방법은 stopPreview 및 release도 해주기 때문에 플래시가 꺼질 때 시간이 좀 걸립니다.
개선된 방법인 플래시 끄기 방법2에서는 카메라 플래시 모드를 FLASH_MODE_OFF로 파라미터 설정해주기만 하면 되기에 속도가 빠릅니다.

그 외에 몇 군데 다르게 처리해야 하는 부분들도 있습니다.

앞서 간단히 언급한 부분이기도 한데, 플래시 끄는 곳에서는 카메라 파라미터에 플래시 모드를 off 해주는 것 외에는 다른 처리를 하지 않고 있어서 카메라 프리뷰 종료 및 카메라 인스턴스를 릴리즈하는 코드는 onPause 쪽에 넣어주어야 합니다.

그리고, 그 코드가 onPause로 이동했기에 객체의 인스턴스 생성하는 코드는 onResume에 넣어주는 게 적당합니다.

자세한 코드는 소스를 첨부하니 참고하시길 바랍니다.
PermissionFlashlight2.zip

이상으로 "손전등 앱 만들기 첫 번째 - 개요 및 Camera API 이용방법"에 대해서 설명해 드렸습니다.
다음번에는 Camera2 API 이용해서 손전등 앱을 만들어 보도록 하겠습니다.

조금이나마 도움이 되셨으면 아래 ♡공감 버튼을 눌러주세요.
(If this article helps you, please press the ♡button below.)

메모리 누수 (Memory Leak) 이야기

간단하게 정의하면 앱에서 사용한 메모리를 반환하지 않는 현상입니다.

결과적으로 이후 가용 메모리가 줄어듭니다.

좀 더 자세히 설명하면, 안드로이드에서는 메모리가 부족하면 GC(Garbage Collector)가 동작해서 더는 유용하지 않는 객체들을 정리해서 메모리를 확보하게 됩니다.

그래서, 자바에서는 GC가 있기 때문에 메모리 누수가 없다고 하는데, 꼭 그런 것만은 아닙니다.

유용한 객체에서 유용하지 않는 객체를 참조(reference)하는 경우에 GC는 유용하지 않는 객체지만 제거할 수 없게 되어서 메모리 누수가 발생합니다. 

메모리 누수는 Exception이나 ANR 처럼 FC(Force Close) 되어서 문제가 있다는 것을 즉각 인지할 수 있는 것도 아니고, 직접적인 단서가 될 로그 정보가 있는 것도 아닙니다. 물론 누수가 심각해서 이후 메모리 할당을 못 할 경우 OOM(Out Of Memory) Exception까지 되는 경우도 있기는 합니다.

재현되는 경로가 확인되었고, 누수되는 메모리량이 커서 OOM 까지 되는 경우에는 그나마 인지할 수 있어서 다행이지만, 재현되는 경로 확인이 어렵고 누수되는 메모리량이 많지 않을 때에는 인지하기 어렵기 때문에 그대로 릴리즈될 수 있습니다.

이런 경우 문제는 메모리 누수가 있는 앱이 사용 빈도가 높을 경우 메모리 누수량이 계속 누적된다는 것입니다.

단말기 제조업체의 경우 QA에서 최종 릴리즈 전에 메모리 누수 테스트를 하고 있지만, 구글 플레이에 올라와 있는 앱들 중에서는 메모리 누수되는 앱들이 존재합니다.

이런 앱들은 사용자에게 어떤 영향을 미칠까요?

다운로드 한 앱들이 메모리 누수가 지속적으로 발생하게 되면 가용 메모리가 부족하게 되어 이후 메모리 확보를 위해서 GC가 동작하게 됩니다.

이때 화면이 렌더링 처리되어야 하는 16ms를 초과하는 GC시간이 빈번할 경우(특히 100ms 이상의 GC)에 일반적으로 버벅거린다고 말하는 Sluggish 현상을 사용자들이 경험하게 됩니다.

가용 메모리가 일정 수준 이하이면 LMK(Low Memory Killer) 를 트리거시킵니다. LMK 는 중요한 프로세스를 보호하기 위해서 중요하지 않은 프로세스를 Kill 후 메모리를 확보합니다. LMK 관련해서는 나중에 별도로 다룰 예정입니다.

최악의 경우 앞서 언급한 OOM 상황이 되면 다른 앱의 실행이 안 될 수도 있습니다.
많은 메모리 할당이 요구되는 앱들이 OOM으로 인한 FC로 괜한 오해를 받게 됩니다.

메모리 누수는 사용자 입장에서도 개발자 입장에서도 불편한 이슈입니다.

메모리 누수를 검출하는 많이 알려진 방법은 meminfo 나 procstats 명령을 통한 메모리양의 단순 비교로 메모리 누수 여부에 대해서 검출하는 것입니다. 하지만, 좀 더 편리하고 정확한 위치를 찾기 위한 툴들을 이용합니다.

Eclipse에서 안드로이드 개발할 때 DDMS(Dalvik Debug Monitor Server) 의 Heap dump와 Allocation Tracker를 이용했고, 플러그인 형태의 MAT(Memory Analysis Tool)를 사용해서 메모리 누수를 찾았습니다.

Android studio로 넘어오면서 Android Profiler라는 이름으로 CPU, MEMORY, NETWORK 항목들의 각 Profiler 가 통합되었고, MEMORY Profiler에서 이전 DDMS처럼 메모리 누수를 찾을 수 있었습니다.

이후 소개할 LeakCanary는 PC에서 동작하던 툴들과 달리 폰에서 메모리 누수가 있는 앱을 실행후 액티비티를 종료하게 되면 백그라운드 프로세스로 동작하면서 모니터링 후 메모리 누수가 검출시 Notificaiton으로 알려주기에 이전 툴들에 비해 사용이 쉽고 직관적입니다.

LeakCanary 를 이용한 메모리 누수 검출

먼저 LeakCanary 에 대한 간단한 설명을 하자면, 미국에 있는 Square라는 회사에서 메모리 누수를 검출하기 위해서 만든 라이브러리입니다.

참고로 이 회사는 모바일 지불 및 금융/가맹점 서비스 관련한 기업인데, 트위터 창업자 잭도시가 이 회사도 만들었습니다.

안드로이드 개발하면서 이 회사에서 공개한 라이브러리(Picasso, Moshi, OkHttp, Retrofit 등)를 알게 모르게 사용하거나 들어본 적이 있을 것입니다.

자사 앱의 메모리 누수를 해결하는 과정에 만들어진 라이브러리라고 하고, 이후 외부에 공개되었습니다.

LeakCanary는 액티비티가 종료(Destroy)되었지만, GC에 의해 회수되지 않는 메모리가 검출되면 별도의 프로세스에서 Heap Dump 후 hprof 파일로 저장하고 분석을 해서 결과를 리포트합니다. 

[LeakCanary 적용방법]

1. 아래 라이브러리를 build.gradle 화일에 추가합니다.

     LeakCanary는 Debug 모드에서만 동작합니다.

     Release 모드 라이브러리는 자바 쪽 LeakCanary 코드가 아무런 동작하지 않도록 처리되어 있습니다.

debugImplementation 'com.squareup.leakcanary:leakcanary-android:1.6.1'
releaseImplementation 'com.squareup.leakcanary:leakcanary-android-no-op:1.6.1'

2. Custom Application class를 만들어주고, LeakCanary 설치 코드를 추가합니다.

package com.example.help.myapplication;

import android.app.Application;
import com.squareup.leakcanary.LeakCanary;

public class myapplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        if (LeakCanary.isInAnalyzerProcess(this)) {
            // This process is dedicated to LeakCanary for heap analysis.
            // You should not init your app in this process.
            return;
        }
        LeakCanary.install(this);
    }
}

android:name도 추가해줍니다.

<application
    android:name=".myapplication"
    android:allowBackup="true"
    android:icon="@mipmap/ic_launcher"
    android:label="@string/app_name"
    android:roundIcon="@mipmap/ic_launcher_round"
    android:supportsRtl="true"
    android:theme="@style/AppTheme">
    <activity android:name=".MainActivity">
        <intent-filter>
            <action android:name="android.intent.action.MAIN" />

            <category android:name="android.intent.category.LAUNCHER" />
        </intent-filter>
    </activity>
</application>

[LeakCanary 이용 메모리 누수 검출 테스트]

뷰나 액티비티를 static field로 참조하는 경우 액티비티가 종료되어도 GC로 메모리가 회수되지 않습니다.
아래의 경우 mText가 여기에 해당합니다.

public class MainActivity extends AppCompatActivity {
  static TextView mText;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    mText = new TextView(this);
    mText.setLayoutParams(new ViewGroup.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT));
    mText.setText(getString(R.string.app_name));
    ((ConstraintLayout) findViewById(R.id.mainActivityLayout)).addView(mText);
  }
}

앞서 기술한 LeakCanary를 적용 후 앱 실행해서 액티비티를 종료하면 잠시후에 아래와 같이 Notification과 더불어 메모리를 Heap Dump 하고 있다고 알려주는 창이 나옵니다.

이때 Notification 창을 내려서 확인해보면 Heap Dump 완료 직후 분석을 진행하고 있습니다.
분석이 완료되면, 메모리 누수가 발생한 액티비티가 표시됩니다.

더 자세한 내용을 확인하기 위해서 Notification 창을 클릭하게 되면 아래와 같이 확인할 수 있습니다.

또한 Logcat을 통해서도 확인이 가능합니다.

프로젝트 압축화일  MyApplication.zip

이상으로 메모리 누수에 대한 이야기와 LeakCanary를 이용한 메모리 누수 검출방법에 대해서 알아보았습니다.

조금이나마 도움이 되셨으면 아래 ♡공감 버튼을 눌러주세요.