Android :: SharedPreferences를 이용한 자동 로그인 기능

💡 SharedPreferences

 

SharedPreferences는 (key, value) 형태로 관리되며, 간단한 값 저장에 사용하기 좋다.

데이터의 양이 많다면 서버나 DB의 형태로 저장을 하는 것이 좋지만, 초기 설정값이나 자동 로그인과 같이 간단한 데이터를 저장해야 하는 경우에는 SharedPreferences를 사용하여 쉽게 관리할 수 있다.

 

 

1. SharedPreferences 생성

val prefs : SharedPreferences = context.getSharedPreferences("Prefs", Context.MODE_PRIVATE)
val editor : SharedPreferences.Editor = prefs.edit() // 데이터 기록을 위한 editor

(1) getSharedPreferences(key, mode)

MODE_PRIVATE : 자기 앱내에서만 사용할때 (0을 입력해도 된다)

MODE_WORLD_READABLE : 다른 앱에서 읽기 가능

MODE_WORLD_WRITEABLE : 다른 앱에서 쓰기 가능

 

(2) 데이터를 기록하기 위해서는 SharedPreferences.Editor 인스턴스를 얻어야한다.

    생성한 editor를 사용하여 데이터의 저장, 수정, 삭제가 가능하다.

 

2. 데이터 저장

editor.putString(key, value)
editor.commit() // 필수

Editor 객체를 통해 원하는 값을 key, value 형태로 입력하고

commit 해주면 데이터 저장이 완료된다.

여기서 중요한 점은 값을 넣어주고 나서 commit을 꼭 !! 해주어야 한다는 점이다.

저장할 수 있는 데이터 종류는 boolean, int, float, long, string이 있다.

 

3. 저장된 데이터 불러오기

prefs.getString(key, "")

SharedPreferences 객체 prefs를 통해 원하는 값의 key와 defaultValue(key 값이 null일 경우 반환할 값)를

파라미터로 하여 호출하면 값을 받아올 수 있다.

 

4. 모든 데이터 삭제

editor.remove(key)
editor.clear()
editor.commit()

remove(key)를 사용하면 key에 해당하는 데이터가 삭제되고,

clear()를 사용하면 SharedPreferences의 모든 데이터가 삭제된다.

마찬가지로 변경 후에는 commit을 해준다.

 

 

📝 예제

로그인 후 앱을 종료했다가 재시작 시 자동 로그인 되도록 구현

 

< MySharedPreferences.kt >

object MySharedPreferences {
    private val MY_ACCOUNT : String = "account"

    fun setUserId(context: Context, input: String) {
        val prefs : SharedPreferences = context.getSharedPreferences(MY_ACCOUNT, Context.MODE_PRIVATE)
        val editor : SharedPreferences.Editor = prefs.edit()
        editor.putString("MY_ID", input)
        editor.commit()
    }

    fun getUserId(context: Context): String {
        val prefs : SharedPreferences = context.getSharedPreferences(MY_ACCOUNT, Context.MODE_PRIVATE)
        return prefs.getString("MY_ID", "").toString()
    }

    fun setUserPass(context: Context, input: String) {
        val prefs : SharedPreferences = context.getSharedPreferences(MY_ACCOUNT, Context.MODE_PRIVATE)
        val editor : SharedPreferences.Editor = prefs.edit()
        editor.putString("MY_PASS", input)
        editor.commit()
    }

    fun getUserPass(context: Context): String {
        val prefs : SharedPreferences = context.getSharedPreferences(MY_ACCOUNT, Context.MODE_PRIVATE)
        return prefs.getString("MY_PASS", "").toString()
    }

    fun clearUser(context: Context) {
        val prefs : SharedPreferences = context.getSharedPreferences(MY_ACCOUNT, Context.MODE_PRIVATE)
        val editor : SharedPreferences.Editor = prefs.edit()
        editor.clear()
        editor.commit()
    }

}

 

< LoginActivity.kt >

class LoginActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_login)

        // SharedPreferences 안에 값이 저장되어 있지 않을 때 -> Login
        if(MySharedPreferences.getUserId(this).isNullOrBlank()
            || MySharedPreferences.getUserPass(this).isNullOrBlank()) {
            Login()
        }
        else { // SharedPreferences 안에 값이 저장되어 있을 때 -> MainActivity로 이동
            Toast.makeText(this, "${MySharedPreferences.getUserId(this)}님 
            	자동 로그인 되었습니다.", Toast.LENGTH_SHORT).show()
            val intent = Intent(this, MainActivity::class.java)
            startActivity(intent)
            finish()
        }
    }

    fun Login() {

        btn_login.setOnClickListener {

            if(et_id.text.isNullOrBlank() || et_pass.text.isNullOrBlank()) {
                Toast.makeText(this, "아이디와 비밀번호를 확인하세요", Toast.LENGTH_SHORT).show()
            }
            else {
                MySharedPreferences.setUserId(this, et_id.text.toString())
                MySharedPreferences.setUserPass(this, et_pass.text.toString())
                Toast.makeText(this, "${MySharedPreferences.getUserId(this)}님 
                	로그인 되었습니다.", Toast.LENGTH_SHORT).show()
                var intent = Intent(this, MainActivity::class.java)
                startActivity(intent)
                finish()
            }
        }
    }

}

 

< MainActivity.kt >

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        tv_info.setText("ID : " + MySharedPreferences.getUserId(this))

        btn_logout.setOnClickListener {
            MySharedPreferences.clearUser(this)
            val intent = Intent(this, LoginActivity::class.java)
            startActivity(intent)
            finish()
        }
    }
}

 

💻 결과

1. 아이디 패스워드 입력 → 로그인

2. 로그인 된 화면

3. 앱 종료 후 재시작 → 자동 로그인

 

 

 

Android 공식문서 : https://developer.android.com/training/data-storage/shared-preferences?hl=ko