如何从Android中的PreferenceActivity获取SharedPreferences?


373

我正在使用PreferenceActivity显示我的应用程序的一些设置。我通过xml文件扩展设置,以便我的onCreate(和完整的类方法)如下所示:

public class FooActivity extends PreferenceActivity {
    @Override
    public void onCreate(Bundle icicle) {
        super.onCreate(icicle);
        addPreferencesFromResource(R.xml.preference);
    }
}

PreferenceActivity PreferenceFragment的Javadoc 指出:

这些首选项将在用户与它们交互时自动保存为SharedPreferences。要检索此活动中的首选项层次结构将使用的SharedPreferences的实例,请调用getDefaultSharedPreferences(android.content.Context)并在与该活动相同的程序包中使用上下文。

但是,如何在另一个Activity中获得SharedPreference的名称呢?我只能打电话

getSharedPreferences(name, mode)

在其他活动中,但我需要PreferenceActivity使用的SharedPreference的名称。叫什么名字?我怎么找?

Answers:


721
import android.preference.PreferenceManager;
SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(this);
// then you use
prefs.getBoolean("keystring", true);

更新资料

根据共享首选项| Sai Geetha MN的《Android开发人员教程》(第13部分)

许多应用程序可以提供一种捕获用户对特定应用程序或活动的设置的偏好的方法。为了支持这一点,Android提供了一组简单的API。

首选项通常是名称值对。可以将它们作为“共享首选项”存储在应用程序中的各种活动中(请注意,当前无法跨进程共享)。也可能是需要针对某个活动进行存储的东西。

  1. 共享首选项:共享首选项可以由应用程序的所有组件(活动,服务等)使用。

  2. 活动处理的首选项:这些首选项只能在特定活动中使用,而应用程序的其他组件则不能使用。

共享首选项:

共享的首选项getSharedPreferencesContext类的方法的帮助下进行管理。首选项存储在默认文件(1)中,或者您可以指定用于引用首选项的文件名(2)

(1)建议的方式是使用默认模式,而不指定文件名

SharedPreferences preferences = PreferenceManager.getDefaultSharedPreferences(context);

(2)指定文件名时如何获取实例

public static final String PREF_FILE_NAME = "PrefFile";
SharedPreferences preferences = getSharedPreferences(PREF_FILE_NAME, MODE_PRIVATE);

MODE_PRIVATE是首选项的操作模式。这是默认模式,表示创建的文件将仅由调用应用程序访问。支持的其他两种模式是MODE_WORLD_READABLEMODE_WORLD_WRITEABLE。在MODE_WORLD_READABLE其他应用程序中可以读取创建的文件,但不能对其进行修改。在MODE_WORLD_WRITEABLE其他应用程序的情况下,也对创建的文件具有写权限。

最后,一旦有了首选项实例,就可以从首选项中检索存储的值

int storedPreference = preferences.getInt("storedInt", 0);

存储的值在首选项文件SharedPreference.Editor对象必须使用。Editor是类中的嵌套接口SharedPreference

SharedPreferences.Editor editor = preferences.edit();
editor.putInt("storedInt", storedPreference); // value to store
editor.commit();

编辑器还支持remove()和方法,例如clear()从文件中删除首选项值。

活动偏好设置:

共享的首选项可以由其他应用程序组件使用。但是,如果您不需要与其他组件共享首选项,并且想要拥有活动专用首选项,则可以借助getPreferences()活动方法来实现。该getPreference方法使用getSharedPreferences()具有活动类名称的方法作为首选项文件名。

以下是获取首选项的代码

SharedPreferences preferences = getPreferences(MODE_PRIVATE);
int storedPreference = preferences.getInt("storedInt", 0);

存储值的代码也与共享首选项相同。

SharedPreferences preferences = getPreference(MODE_PRIVATE);
SharedPreferences.Editor editor = preferences.edit();
editor.putInt("storedInt", storedPreference); // value to store
editor.commit();

您还可以使用其他方法,例如将活动状态存储在数据库中。注意Android还包含一个名为的软件包android.preference。程序包定义用于实现应用程序首选项UI的类。

要查看更多示例,请查看开发人员网站上Android的数据存储文章。


55
+1:您保存了我的一天。.Internet上的所有教程/示例都没有说明这一点。他们谈论的都是abt的功能和自定义,但没有讲解。
ankitjaininfo 2010年

1
请参阅我的答案更新,文件名类似,package.prefs但我不确定。
Pentium10

1
感谢您的代码。只有一件事让我感到困惑:SharedPreference是一个接口,那么处理任何方法调用的实际代码在哪里?
x1886x 2011年

1
希望我一周前已经读过这篇文章,然后才浪费我的时间在SE上阅读一些愚蠢的书呆子答案/评论,他们认为他们知道自己实际上什么时候都不知道。.感谢@ Pentium10,您拥有任何博客,再次感谢,非常感谢:)
Sanjeevcn 2015年

1
除了使用editor.commit(),还可以使用editor.apply()。区别在于commit()同步写入更改,而apply异步写入。这使您的UI更快。
Hashim Akhtar

29

如果您无权访问getDefaultSharedPreferenes(),则可以getSharedPreferences(name, mode)改用,只需输入正确的名称即可。

Android创建此名称(可能基于项目的包名称吗?)。您可以通过将以下代码放入中SettingsActivity onCreate()并查看是什么来获得它preferencesName

String preferencesName = this.getPreferenceManager().getSharedPreferencesName();

该字符串应类似于com.example.projectname_preferences。在项目中的某个地方进行硬编码,然后将其传递给getSharedPreferences()您,您应该会很高兴。


1
活动的来源为:public SharedPreferences getPreferences(int mode){return getSharedPreferences(getLocalClassName(),mode); }
Ta

22

首先声明这些方法。

public static void putPref(String key, String value, Context context) {
    SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context);
    SharedPreferences.Editor editor = prefs.edit();
    editor.putString(key, value);
    editor.commit();
}

public static String getPref(String key, Context context) {
    SharedPreferences preferences = PreferenceManager.getDefaultSharedPreferences(context);
    return preferences.getString(key, null);
}

然后,当您要放置偏好设置时,调用此命令:

putPref("myKey", "mystring", getApplicationContext());

当您想获得偏好时,请调用此命令:

getPref("myKey", getApplicationContext());

或者, 您可以使用此对象https://github.com/kcochibili/TinyDB--Android-Shared-Preferences-Turbo ,它可以进一步简化一切

例:

TinyDB tinydb = new TinyDB(context);

tinydb.putInt("clickCount", 2);
tinydb.putFloat("xPoint", 3.6f);
tinydb.putLong("userCount", 39832L);

tinydb.putString("userName", "john");
tinydb.putBoolean("isUserMale", true); 

tinydb.putList("MyUsers", mUsersArray);
tinydb.putImagePNG("DropBox/WorkImages", "MeAtlunch.png", lunchBitmap);

为什么不使用editor.apply(); 而不是在后台进行提交处理
Avi Parshan

4

必须到处传递上下文确实让我很烦。代码变得过于冗长和难以管理。我在每个项目中都这样做...

public class global {
    public static Activity globalContext = null;

并将其设置在主活动中

@Override
public void onCreate(Bundle savedInstanceState) {
    Thread.setDefaultUncaughtExceptionHandler(new CustomExceptionHandler(
            global.sdcardPath,
            ""));
    super.onCreate(savedInstanceState);

    //Start 
    //Debug.startMethodTracing("appname.Trace1");

    global.globalContext = this;

同样,所有首选项键都应独立于语言,我很震惊,没有人提到这一点。

getText(R.string.yourPrefKeyName).toString()

现在只需一行代码就可以像这样简单地调用它

global.globalContext.getSharedPreferences(global.APPNAME_PREF, global.MODE_PRIVATE).getBoolean("isMetric", true);

4
使按键语言独立于一体的优势是什么?它们永远不会显示给用户,对吗?
Gerd

1
拜托,出于对上帝的爱,切勿将“活动”用作全局上下文。如果必须使用全局上下文,请使用自定义Application类。
Thorben

1
@Thorben同意。或者简单地说getApplicationContext()
OneCricketeer

3

如果您有一个复选框,并且想获取其值,即在任何Java文件中为true / false,

采用 -

Context mContext;
boolean checkFlag;

checkFlag=PreferenceManager.getDefaultSharedPreferences(mContext).getBoolean(KEY,DEFAULT_VALUE);`

0

更新于2019

您可以简单地使用PowerPreference

https://github.com/AliEsaAssadi/Android-Power-Preference

获取共享首选项实例

要获取默认实例,您只需要调用

PowerPreference.getDefaultFile()

或者,如果您要特定的首选项文件

PowerPreference.getFileByName(fileName)

写入数据:

PowerPreference.getDefaultFile().put(key,value)

获取数据

PowerPreference.getDefaultFile().getString(key,value)

PowerPreference如何处理上下文部分?要读取共享首选项需要上下文,不是吗?我是Android的新手,正在尝试理解。
Yeti

0

尝试遵循对我有用的源代码

//Fetching id from shared preferences
    SharedPreferences sharedPreferences;
    sharedPreferences =getSharedPreferences(Constant.SHARED_PREF_NAME, Context.MODE_PRIVATE);
    getUserLogin = sharedPreferences.getString(Constant.ID_SHARED_PREF, "");
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.