[Android] 간단한 QR 코드 리더기 만들기 : JetPack, CameraX, Google ML kit

 

 

 

 

안드로이드 JetPack 중 CameraX 라이브러리와, 구글 ML 키트를 사용해보기 위해 QR코드 리더기를 만들어 보았다.
역시 Joyce님의 서적을 참고하였다.

 

---

 

💡 Android Jetpack

Android Jetpack 개발자 리소스 - Android 개발자  |  Android Developers

• 구글 안드로이드팀에서 공식 발표한 라이브러리 모음
• 안정성: 모든 안드로이드 버전 및 다양한 기기에서 일관되게 작동하는 라이브러리이므로, 복잡성 낮추고 안정성 높임
• 간편성: 백그라운드 작업, 생명 주기 관리 등을 대신 해주어 보일러플레이트 코드를 줄이고 로직에만 집중 가능
• 젯팩 라이브러리는 모두 [androidx.이름]과 같은 패키지명으로 구성
• 예: AppSearch, CameraX, Compose, Data Binding, LiveData, WorkManager, Navigation, Test, ViewBinding ...

 

 

---

 

💡 CameraX

CameraX 시작하기  |  Android Developers

 

CameraX 아키텍처  |  Android media  |  Android Developers

• 미리보기 (사진 찍기 전 미리보기 화면)
• 이미지 분석 (머신러닝과 같은 이미지 분석)
• 이미지 캡처 (이미지 저장)

 

 

 

---

 

💡 구글 ML키트

ML Kit  |  Google for Developers

• 구글 머신러닝 기술을 안드로이드, iOS와 같은 모바일 기기에서 사용할 수 있게 해주는 라이브러리
• 바코드 스캐닝, 얼굴 인식, 텍스트 인식, 포즈 인식, 언어 감지 등 수많은 API를 제공함

 

 

 

---

 

 

💡 build.gradle 라이브러리 설정

dependencies {
..

    // CameraX core library using the camera2 implementation
    val camerax_version = "1.4.0-alpha05"
    // The following line is optional, as the core library is included indirectly by camera-camera2
    implementation("androidx.camera:camera-core:${camerax_version}")
    implementation("androidx.camera:camera-camera2:${camerax_version}")
    // If you want to additionally use the CameraX Lifecycle library
    implementation("androidx.camera:camera-lifecycle:${camerax_version}")
    // If you want to additionally use the CameraX View class
    implementation("androidx.camera:camera-view:${camerax_version}")
    // If you want to additionally add CameraX ML Kit Vision Integration
    implementation("androidx.camera:camera-mlkit-vision:${camerax_version}")
    // ML Kit 바코드 라이브러리
    implementation("com.google.mlkit:barcode-scanning:17.2.0")
}

 

 

💡 매니페스트 권한 추가

    <uses-feature android:name="android.hardware.camera.any" />
    <uses-permission android:name="android.permission.CAMERA" />

 

 

💡 미리보기 기능 구현 : MainAcitivty

• 미리보기를 구현
• 카메라 권한 승인하기

 

 

💡QR 코드 인식 기능 구현

• CameraX의 Analyzer 클래스 만들기 (QRCodeAnalyzer.kt)
• onDetect() 메서드가 있는 인터페이스 만들기
• MainActivity.kt에서 Analyzer와 카메라 연동하기

 

 

---

 

🔥 완성 코드

 

 

MainActivity.kt

package com.limheejin.qrcodereader

import android.content.Context
import android.Manifest
import android.content.Intent
import android.content.pm.PackageManager
import android.os.Bundle
import android.widget.Toast
import androidx.appcompat.app.AppCompatActivity
import androidx.camera.core.CameraSelector
import androidx.camera.core.ImageAnalysis
import androidx.camera.core.Preview
import androidx.camera.lifecycle.ProcessCameraProvider
import androidx.core.content.ContextCompat
import com.google.common.util.concurrent.ListenableFuture
import com.limheejin.qrcodereader.databinding.ActivityMainBinding
import java.util.concurrent.ExecutorService
import java.util.concurrent.Executors

class MainActivity : AppCompatActivity() {

    private lateinit var binding: ActivityMainBinding
    private lateinit var camerProviderFuture: ListenableFuture<ProcessCameraProvider> // 태스크가 제대로 끝났을 때 동작 지정
    private val PERMISSIONS_REQUEST_CODE = 1 // 태그 기능을 하는 코드로, 0보다 큰 양수면 뭐든 상관 없음
    private val PERMISSONS_REQUIRED = arrayOf(Manifest.permission.CAMERA) // 카메라 권한 지정
    private var isDetected = false // 이미지 분석이 실시간으로 진행되므로, onDetect()가 여러번 호출되는 걸 막기 위해 변수 생성

    // 다시 사용자의 포커스가 MainActivity로 온다면 다시 QR을 인식할 수 있도록
    override fun onResume() {
        super.onResume()
        isDetected = false
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivityMainBinding.inflate(layoutInflater)
        setContentView(binding.root)

        if (!hasPermissions(this)) {
            requestPermissions(PERMISSONS_REQUIRED, PERMISSIONS_REQUEST_CODE) // 권한 요청
        } else {
            startCamera() // 이미 권한이 있다면 카메라 시작
        }
    }

    // 권한 유무 확인
    private fun hasPermissions(context: Context) =
        PERMISSONS_REQUIRED.all { // .all은 배열의 원소가 모두 조건문을 만족하면 true, 아니면 false
            ContextCompat.checkSelfPermission(context, it) == PackageManager.PERMISSION_GRANTED
        }

    // 권한 요청 콜백 함수
    override fun onRequestPermissionsResult(
        requestCode: Int,
        permissions: Array<String>,
        grantResults: IntArray
    ) {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults)

        // requestPermissions의 인수로 넣은 PERMISSION_REQUEST_CODE와 맞는지 확인
        if (requestCode == PERMISSIONS_REQUEST_CODE) {
            if (PackageManager.PERMISSION_GRANTED == grantResults.firstOrNull()) {
                Toast.makeText(this@MainActivity, "권한 요청이 승인되었습니다.", Toast.LENGTH_LONG).show()
                startCamera()
            } else {
                Toast.makeText(this@MainActivity, "권한 요청이 거부되었습니다.", Toast.LENGTH_LONG).show()
                finish()
            }
        }
    }

    // 미리보기와 이미지 분석 시작
    fun startCamera() {
        camerProviderFuture = ProcessCameraProvider.getInstance(this) // 객체의 참조값 할당
        camerProviderFuture.addListener(Runnable { // cameraProviderFuter 태스크가 끝나면 실행
            val cameraProvider =
                camerProviderFuture.get() // 카메라의 생명주기를 액티비티나 프래그먼트의 생명주기에 바인드해주는 ProcessCameraProvider 객체 가져옴
            val preview = getPreview() // 미리보기 객체 가져옴
            val imageAnalysis = getImageAnalysis() // ImageAnalysis의 객체 생성
            val cameraSelector = CameraSelector.DEFAULT_BACK_CAMERA // 후면 카메라 선택
            cameraProvider.bindToLifecycle(this, cameraSelector, preview, imageAnalysis) // 미리보기 기능 선택, imageAnalysis 객체 넣음 -> 이미지 분석 기능 사용 가능
        }, ContextCompat.getMainExecutor(this))
    }

    // 미리보기 기능을 설정하고 설정이 완료된 객체 밙환
    fun getPreview(): Preview {
        val preview: Preview = Preview.Builder().build() // Preview 객체 생성
        preview.setSurfaceProvider(binding.barcodePreview.getSurfaceProvider())
        return preview
    }

    // 이미지 분석 기능
    fun getImageAnalysis(): ImageAnalysis {
        val cameraExecutor: ExecutorService = Executors.newSingleThreadExecutor()
        val imageAnalysis = ImageAnalysis.Builder().build()

        // Analyzer 설정
        imageAnalysis.setAnalyzer(
            cameraExecutor,
            QRCodeAnalyzer(object : OnDetectListener {
                override fun onDetect(msg: String) {
                    if (!isDetected) {
                        isDetected = true // 데이터가 감지되었으므로 true로 바꿔줌
                        val intent = Intent(this@MainActivity, ResultActivity::class.java)
                        intent.putExtra("msg", msg) // 인텐트로 액티비티 이동 및 키-쌍 형태로 데이터 전달
                        startActivity(intent)
                    }
                }
            }))
        return imageAnalysis
    }
}

 

 

 

인터페이스 : OnDetectListener.kt

package com.limheejin.qrcodereader

interface OnDetectListener {
    fun onDetect(msg: String) // QRCodeAnalyzer에서 QR코드가 인식되었을 때 호출할 함수, 데이터 내용이 인수
}

 

인터페이스 필요 이유 : 인식 완료 후 전달을 위한 소통 창구

 

 

QRCodeAnalyzer.kt

package com.limheejin.qrcodereader

import android.annotation.SuppressLint
import androidx.camera.core.ImageAnalysis
import androidx.camera.core.ImageProxy
import com.google.mlkit.vision.barcode.BarcodeScanning
import com.google.mlkit.vision.common.InputImage


class QRCodeAnalyzer(val onDetectListener: OnDetectListener) : ImageAnalysis.Analyzer {

    // 바코드 스캐닝 객체 생성
    private val scanner = BarcodeScanning.getClient()

    @SuppressLint("UnsafeOptInUsageError")
    override fun analyze(imageProxy: ImageProxy) {
        val mediaImage = imageProxy.image
        if (mediaImage != null) {
            val image =
                InputImage.fromMediaImage(mediaImage, imageProxy.imageInfo.rotationDegrees)
                // 이미지가 찍힐 당시 카메라의 회전 각도를 고려하여 입력 이미지를 생성
            scanner.process(image) // 이미지 분석
                .addOnSuccessListener { qrCodes ->
                    for (qrCode in qrCodes) { // qrCodes와 같은 배열인 이유 : 한 화면에 다수의 QR코드가 있다면 각각 배열로 보내기 위해
                        onDetectListener.onDetect(qrCode.rawValue ?: "")
                    }
                }
                .addOnFailureListener {
                    it.printStackTrace() // 실패시 에러를 로그에 프린트
                }
                .addOnCompleteListener {
                    imageProxy.close() // 스캐너가 이미지를 분석 완료했을 때 이미지 프록시를 닫음
                }
        }
    }
}

 

 

ResultActivity.kt

package com.limheejin.qrcodereader

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import com.limheejin.qrcodereader.databinding.ActivityResultBinding

class ResultActivity : AppCompatActivity() {
    private lateinit var binding: ActivityResultBinding

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivityResultBinding.inflate(layoutInflater)
        setContentView(binding.root)

        val result = intent.getStringExtra("msg") ?: "데이터가 존재하지 않습니다."
        setUI(result)
    }

    private fun setUI(result: String) {
        binding.tvResult.text = result
        binding.btnGoBack.setOnClickListener { finish() }
    }
}