Exemplo de Tutorial de Preferências Compartilhadas no Android

Neste tutorial, vamos usar Shared Preferences em nossa aplicação android para armazenar dados na forma de par chave-valor.

Visão Geral das Shared Preferences do Android

As Shared Preferences permitem que atividades e aplicativos mantenham preferências na forma de pares chave-valor, semelhantes a um Mapa, que persistirão mesmo quando o usuário fechar o aplicativo. O Android armazena as configurações de Shared Preferences como um arquivo XML na pasta shared_prefs dentro do diretório DATA/data/{pacote do aplicativo}. A pasta DATA pode ser obtida chamando Environment.getDataDirectory(). SharedPreferences são específicos do aplicativo, ou seja, os dados são perdidos ao realizar uma das seguintes opções:

  • ao desinstalar o aplicativo
  • ao limpar os dados do aplicativo (através das Configurações)

Como o nome sugere, o objetivo principal é armazenar detalhes de configuração especificados pelo usuário, como configurações específicas do usuário, mantendo o usuário conectado ao aplicativo. Para acessar as preferências, temos três APIs para escolher:

  • getPreferences() : usada de dentro de sua Activity, para acessar preferências específicas da atividade
  • getSharedPreferences() : usada de dentro de sua Activity (ou outro Contexto do aplicativo), para acessar preferências em nível de aplicativo
  • getDefaultSharedPreferences(): usado no PreferenceManager, para obter as preferências compartilhadas que funcionam em conjunto com o framework de preferências geral do Android

Neste tutorial, vamos usar getSharedPreferences(). O método é definido da seguinte forma: getSharedPreferences (String PREFS_NAME, int mode) PREFS_NAME é o nome do arquivo. mode é o modo de operação. Seguem os modos de operação aplicáveis:

  • MODE_PRIVATE: o modo padrão, onde o arquivo criado só pode ser acessado pela aplicação que o criou
  • MODE_WORLD_READABLE: Criar arquivos acessíveis mundialmente é muito perigoso e provavelmente causará brechas de segurança nas aplicações
  • MODE_WORLD_WRITEABLE: Criar arquivos graváveis mundialmente é muito perigoso e provavelmente causará brechas de segurança nas aplicações
  • MODE_MULTI_PROCESS: Este método verificará a modificação das preferências mesmo que a instância de Preferência Compartilhada já tenha sido carregada
  • MODE_APPEND: Isso irá acrescentar as novas preferências às preferências já existentes
  • MODE_ENABLE_WRITE_AHEAD_LOGGING: Sinalizador de abertura do banco de dados. Quando definido, habilita o registro de escrita antecipada por padrão

Inicialização

Precisamos de um editor para editar e salvar as alterações nas preferências compartilhadas. O código a seguir pode ser usado para obter as preferências compartilhadas.

SharedPreferences pref = getApplicationContext().getSharedPreferences("MyPref", 0); // 0 - for private mode
Editor editor = pref.edit();

Armazenando Dados

O editor.commit() é usado para salvar as alterações nas preferências compartilhadas.

editor.putBoolean("key_name", true); // Storing boolean - true/false
editor.putString("key_name", "string value"); // Storing string
editor.putInt("key_name", "int value"); // Storing integer
editor.putFloat("key_name", "float value"); // Storing float
editor.putLong("key_name", "long value"); // Storing long
 
editor.commit(); // commit changes

Recuperando Dados

Os dados podem ser recuperados das preferências salvas chamando getString() da seguinte forma:

pref.getString("key_name", null); // getting String
pref.getInt("key_name", -1); // getting Integer
pref.getFloat("key_name", null); // getting Float
pref.getLong("key_name", null); // getting Long
pref.getBoolean("key_name", null); // getting boolean

Limpando ou Excluindo Dados

O remove(“nome_da_chave”) é usado para excluir aquele valor específico. clear() é usado para remover todos os dados

editor.remove("name"); // will delete key name
editor.remove("email"); // will delete key email
 
editor.commit(); // commit changes
editor.clear();
editor.commit(); // commit changes

Estrutura do Projeto

Código do Projeto de Preferências Compartilhadas do Android

O layout activity_main.xml consiste em duas vistas EditText que armazenam e exibem nome e email. Os três botões implementam seus respectivos onClicks na classe MainActivity.

<RelativeLayout xmlns:android="https://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin" >

    <Button
        android:id="@+id/btnSave"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_centerVertical="true"
        android:layout_alignParentLeft="true"
        android:layout_alignParentStart="true"
        android:onClick="Save"
        android:text="Save" />

    <Button
        android:id="@+id/btnRetr"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_centerHorizontal="true"
        android:layout_centerVertical="true"
        android:onClick="Get"
        android:text="Retrieve" />

    <Button
        android:id="@+id/btnClear"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_alignRight="@+id/etEmail"
        android:layout_centerVertical="true"
        android:layout_alignParentRight="true"
        android:layout_alignParentEnd="true"
        android:onClick="clear"
        android:text="Clear" />

    <EditText
        android:id="@+id/etEmail"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:ems="10"
        android:hint="Email"
        android:inputType="textEmailAddress"
        android:layout_below="@+id/etName"
        android:layout_marginTop="20dp"
        android:layout_alignParentRight="true"
        android:layout_alignParentEnd="true" />

    <EditText
        android:id="@+id/etName"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:ems="10"
        android:hint="Name"
        android:inputType="text"
        android:layout_alignParentTop="true"
        android:layout_alignLeft="@+id/etEmail"
        android:layout_alignStart="@+id/etEmail" />

</RelativeLayout>

O arquivo MainActivity.java é usado para salvar e recuperar dados através de chaves.

package com.journaldev.sharedpreferences;

import android.app.Activity;
import android.content.Context;
import android.content.SharedPreferences;
import android.os.Bundle;
import android.view.Menu;
import android.view.View;
import android.widget.TextView;

public class MainActivity extends Activity {
    SharedPreferences sharedpreferences;
    TextView name;
    TextView email;
    public static final String mypreference = "mypref";
    public static final String Name = "nameKey";
    public static final String Email = "emailKey";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        name = (TextView) findViewById(R.id.etName);
        email = (TextView) findViewById(R.id.etEmail);
        sharedpreferences = getSharedPreferences(mypreference,
                Context.MODE_PRIVATE);
        if (sharedpreferences.contains(Name)) {
            name.setText(sharedpreferences.getString(Name, ""));
        }
        if (sharedpreferences.contains(Email)) {
            email.setText(sharedpreferences.getString(Email, ""));

        }

    }

    public void Save(View view) {
        String n = name.getText().toString();
        String e = email.getText().toString();
        SharedPreferences.Editor editor = sharedpreferences.edit();
        editor.putString(Name, n);
        editor.putString(Email, e);
        editor.commit();
    }

    public void clear(View view) {
        name = (TextView) findViewById(R.id.etName);
        email = (TextView) findViewById(R.id.etEmail);
        name.setText("");
        email.setText("");

    }

    public void Get(View view) {
        name = (TextView) findViewById(R.id.etName);
        email = (TextView) findViewById(R.id.etEmail);
        sharedpreferences = getSharedPreferences(mypreference,
                Context.MODE_PRIVATE);

        if (sharedpreferences.contains(Name)) {
            name.setText(sharedpreferences.getString(Name, ""));
        }
        if (sharedpreferences.contains(Email)) {
            email.setText(sharedpreferences.getString(Email, ""));

        }
    }

    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        // Infla o menu; isso adiciona itens à barra de ação, se presente.
        getMenuInflater().inflate(R.menu.menu_main, menu);
        return true;
    }

}

mypreference é o nome do arquivo onde o par chave-valor das preferências compartilhadas é armazenado. A imagem abaixo mostra a saída final do nosso projeto: Isso conclui este tutorial. Você pode baixar o projeto Android Shared Preferences no link abaixo.

Baixar Exemplo de Projeto de Preferências Compartilhadas do Android

Source:
https://www.digitalocean.com/community/tutorials/android-shared-preferences-example-tutorial