1 前言1.1 为什么需要开发规范1.基本一个软件生命周期四分之三以上的时间都用于维护。2.商业项目开发和自己写着玩不一样，基本上没有什么软件整个生命周期都是最初的开发者维护。3.增加代码可读性，新的开发人员入手简单。4.方便团队协同合作5.方便自己维护开发1.2 开发规范的作用1.减少维护成本2.提高可读性3.加快工作交接4.减少名字的增生5.减低缺陷引入机会6.有利于团队多人开发1.3 目前有哪些规范## 1. 阿里云规范## 2. google规范33 3. ...2 命名规范2.1 常量命名规范2.1.1 说明常量用于保存需要常驻内存中并经常使用的数据，定义常量名称需要参照以下的原则。2.1.2 原则1.名称全为大写2.单词之间使用 _ （下划线）连接3.望文知意原则2.2 变量命名规范2.2.1 说明变量用于保存系统中临时数据，变量命名需参照一下原则。2.2.2 原则1.首字母小写2.JAVA驼峰命名3.望文知意原则4.推荐引用变量类型添加前缀“m”5.如果是View组件变量，则组件命名则是xml中控件id去掉下划线，并且下划线后一位字母大写。2.3 方法命名规范2.3.1 说明方法命名应该遵从简单明了原则。2.3.2 原则1.首字母小写2.JAVA驼峰命名3.望文知意原则4.简单明了原则5.方法里代码不易过长，逻辑代码太长可以拆分多个方法6.尽量抽取公用方法，提高代码复用率，降低重复和累赘2.4 类名命名规范2.4.1 说明类的命名应该遵从望文知意原则，表达出一个类的作用。2.4.2 原则1.首字母大写2.JAVA驼峰命名3.望文知意原则4.需要在类名上加上类生成时间、生成者、类的作用和简介的注释5.Activity类应以Activity结尾6.Fragment类应以Fragment结尾7.Service类应以Service结尾8.BroadcastReceiver应以Receiver结尾9.ContentProvider类应以Provider结尾10.Application类应以Application结尾11.自定义View应以View结尾12.自定义Adapter应以Adapter结尾13.Adapter中自定义Holder应以Holder结尾14.重写View应以重写之前View为结尾（视情况而定）15.工具类应以Utils结尾16.帮助类应以Helper结尾17.管理类应以Manager结尾18.实现了应以Impl结尾19....2.5 接口命名规范2.5.1 说明接口命名应该简洁明了，不宜过长。2.5.2 原则1.首字母大写2.JAVA驼峰命名3.望文知意原则4.简单明了原则5.可以在接口前面带一个“I”，也就是前面两个字母大写。2.6 包名命名规范2.6.1 说明用于分类，管理类的文件夹。遵从简单明了原则。2.6.2 原则1.所有字母小写2.分层级，不能拼接3.望文知意原则4.简单明了原则5.按功能需求划分，例如：工具类可以划分一个utils包名6.一般Activity类划分在activity包，同理Fragment也是一样。2.7 目录命名规范2.7.1 说明主要存放一些json、so、jar等文件2.6.2 原则1.所有字母小写2.分层级，不能拼接3.望文知意原则4.简单明了原则5.jar一般存放在libs，组件化模块化开发也可以单独拎出来。so也是一样。2.8 布局控件ID命名规范2.8.1 说明一般是XML文件中控件id命名参照以下原则。2.8.2 原则1.所有字母小写2.单词之间使用_（下划线）分隔3.望文知意原则4.简单明了原则5.开头一般是控件简写，例如：TextView简写tv，ImageView简写iv、EditText简写et2.9 资源文件命名规范2.9.1 说明一般是XML文件中控件id命名参照以下原则。2.9.2 原则1.所有字母小写2.单词之间使用_（下划线）分隔3.望文知意原则4.简单明了原则5.drawable开头一般是资源类型，例如：shape、item、sel等6.activity和fragment分别以activity和fragment开头。7.自定义View命名一般都是父类名大写字母前面带下划线，变成小写，开头字母不用带下划线。8.dialog布局文件一般以dialog开头3. 注释规范3.1 类注释在类、接口定义之前当对其进行注释，包括类、接口的目的、作用、功能、继承于何种父类，实现的接口、实现的算法、使用方法、示例程序等。/** * Description: desc * Created by author on yyyy/MM/dd * * @author author */3.2 方法注释在方法定义之后对其进行注释，包括方法的目的、作用、功能、使用方法、示例程序、传入的参数说明、返回值类型说明、异常说明等。/** * desc:描述 * @param 参数名 参数描述 * @param 参数名2 参数描述 * @return 返回值类型说明 * @throws Exception 异常说明 */3.3 类成员变量和常量注释一般常量都会进行注释，变量和常量注释位于其之上。/** * 描述 **/ 3.4 内部逻辑注释内部逻辑注释一般是单行注释或多行注释，注释在需要注释逻辑代码之上。不能注释在代码后面。//成功 /*失败*/4. 代码顺序/** * Description: desc * Created by author on yyyy/MM/dd * * @author author */ public class Class { // （1）成员常量集合 // （2）成员变量集合 // （3）回调方法集合 // （4）生命周期集合 // （5）其他方法集合 }5. 代码风格5.1 大括号换行左大括号不换行，右大括号换行； class ClassName { private void fun() { if (...) { // ... } else if (...) { // ... } else { // ... } } }5.2 小括号空格if (...) { ... } 5.3 行代码长度1. 一行代码不易过长，不宜超过100个字符。除以下情况： （1）注释 （2）import这里限制主要是需要阅读的代码，例如：逻辑代码等。5.4 声明变量1. 一般一行只声明一个变量。2. 方便注释3. 简介干净，不显得臃肿。5.5 if-else语句1. if后面一定带{}，哪怕只有一行代码，这样可以减少格式错误。2. 参照5.1和5.25.6 for语句1. 当在for语句的初始化或更新子句中使用逗号时，避免因使用三个以上变量，而导致复杂度提高。2. 若需要，可以在for循环之前(为初始化子句)或for循环末尾(为更新子句）使用单独的语句。5.7 while语句1. 与只有if语句类似，只是把if改成while，其他格式不变。while (condition) { statements; }5.8 do-while语句do { statements; } while (condition);5.10 switch语句1. 每当一个case顺着往下执行时（因为没有break语句），通常应在break语句的位置添加注释。2. 都要一个default，哪怕你现在不用。switch (condition) { case A: ... /* falls through */ case B: ... break; case C: .... break; default: .... break; }6. 异常命名规范6.1 异常名称规范定义异常的时候，异常后缀以Exception结尾6.2 try-catch语句try { statements; } catch (ExceptionClass e) { statements; }6.3 try-catch-finally语句try { statements; } catch (ExceptionClass e) { statements; } finally { statements; }7 其他7.1 使用TODO注释1. 对那些临时性的、短期的、够棒但不完美的代码，请使用 TODO 注释。2. TODO 注释应该包含全部大写的 TODO，后跟一个冒号：// TODO: Do something7.2 线程使用1. 尽量多使用线程池，少用裸露的线程。2. 复杂定时线程少用Timer线程，可以使用线程池。3. 具体详情可以参考阿里云命名规则和google命名规则。7.3 Log的使用1. 尽量多使用自定义Log，避免正式环境打印log影响性能。 后续如果有新的再补充....

一、作用    省内存播放声音二、使用    1、导包 implementation 'org.xutils:xutils:3.3.36'    2、在需要的地方插入//加载ogg格式的音频 asset/Sounds下music.ogg int soundId = PlaySound.loadFile("file:///android_asset/Sounds/music.ogg"); //播放 PlaySound.play(soundId);三、注意和详解    1、加载后不能立即播放，因为SoundPool加载需要一点准备（时间很短）    2、建议使用线程和OGG格式的音频，不建议WAV    3、加载的音频尽量<6s，根据官方文档，因设备不同播放的时长也不同，音频过长只能播放一部分，它只有1MB的内存使用    4、每个音频文件大小要小于100k；可以修改音频码率来压缩音频大小，把 128kbps改成32kbps    5、使用soundId 只能暂停一次声音，你要调用停止在流ID ，而不是 soundId 。一个soundId指特定声音的资源，但在流ID是指声音播放的单个实例。所以，如果你玩同样的声音3次，你有一个soundId和三个streamIds。mStreamId = SoundPoolUtil.play(soundId); //正确 SoundPoolUtil.stop(mStreamId); //错误 SoundPoolUtil.stop(soundId);    6、创建一个SoundPool详解public SoundPool(int maxStream, int streamType, int srcQuality) maxStream —— 同时播放的流的最大数量 streamType —— 流的类型，一般为STREAM_MUSIC(具体在AudioManager类中列出) srcQuality —— 采样率转化质量，当前无效果，使用0作为默认值    7、加载音频资源详解可以通过四种途径来记载一个音频资源： 1.通过一个AssetFileDescriptor对象 int load(AssetFileDescriptor afd, int priority) 2.通过一个资源ID int load(Context context, int resId, int priority) 3.通过指定的路径加载 int load(String path, int priority) 4.通过FileDescriptor加载 int load(FileDescriptor fd, long offset, long length, int priority)     8、播放控制详解有以下几个函数可用于控制播放： 1.播放指定音频的音效，并返回一个streamID final int play(int soundID, float leftVolume, float rightVolume, int priority, int loop, float rate) priority —— 流的优先级，值越大优先级高，影响当同时播放数量超出了最大支持数时SoundPool对该流的处理； loop —— 循环播放的次数，0为值播放一次，-1为无限循环，其他值为播放loop+1次（例如，3为一共播放4次）. rate —— 播放的速率，范围0.5-2.0(0.5为一半速率，1.0为正常速率，2.0为两倍速率) 2.暂停指定播放流的音效（streamID 应通过play()返回 final void pause(int streamID) 3.继续播放指定播放流的音效（streamID 应通过play()返回 final void resume(int streamID) 4.终止指定播放流的音效（streamID 应通过play()返回 final void stop(int streamID) 这里需要注意的是： 1.play()函数传递的是一个load()返回的soundID——指向一个被记载的音频资源 ，如果播放成功则返回一个非0的streamID——指向一个成功播放的流 ；同一个soundID 可以通过多次调用play()而获得多个不同的streamID (只要不超出同时播放的最大数量)； 2.pause()、resume()和stop()是针对播放流操作的，传递的是play()返回的streamID ; 3.play()中的priority参数，只在同时播放的流的数量超过了预先设定的最大数量是起作用，管理器将自动终止优先级低的播放流。如果存在多个同样优先级的流，再进一步根据其创建事件来处理，新创建的流的年龄是最小的，将被终止； 4.无论如何，程序退出时，手动终止播放并释放资源是必要的。     9、更多设置详解其实就是paly()中的一些参数的独立设置： 1.设置指定播放流的循环. final void setLoop(int streamID, int loop) 2.设置指定播放流的音量. final void setVolume(int streamID, float leftVolume, float rightVolume) 3.设置指定播放流的优先级，上面已说明priority的作用. final void setPriority(int streamID, int priority) 4.设置指定播放流的速率，0.5-2.0. final void setRate(int streamID, float rate)     10、释放资源详解1.卸载一个指定的音频资源. final boolean unload(int soundID) 2.释放SoundPool中的所有音频资源. final void release() 四、代码import android.content.res.AssetFileDescriptor; import android.content.res.AssetManager; import android.media.AudioAttributes; import android.media.SoundPool; import org.xutils.x; import java.io.IOException; public class PlaySoundUtil { static final String assetPrefix = "file:///android_asset"; static SoundPool _soundPool = null; static int _priority = 0; public static int loadFile(String path) { SoundPool soundPool = getSoundPool(); int soundId = 0; if (path.startsWith(assetPrefix)) { String assetpath = path.substring(assetPrefix.length()+1); AssetManager assets = x.app().getAssets(); try { AssetFileDescriptor afd = assets.openFd(assetpath); soundId = soundPool.load(afd, 1); } catch (IOException e) { e.printStackTrace(); soundId = 0; } } else { soundId = soundPool.load(path, 1); } return soundId; } public static boolean play(int id) { SoundPool soundPool = getSoundPool(); int ret = soundPool.play(id, 1.0f, 1.0f, _priority, 0, 1.0f); _priority++; if (_priority < 0) _priority = 0; return (ret != 0); } public static void stop(int id) { SoundPool soundPool = getSoundPool(); soundPool.pause(id); } private static SoundPool getSoundPool() { if (_soundPool == null) { _soundPool = new SoundPool.Builder() .setAudioAttributes(new AudioAttributes.Builder() .setContentType(AudioAttributes.CONTENT_TYPE_MUSIC) .build()) .setMaxStreams(1) .build(); } return _soundPool; } } 

一、作用    很多情况会用到数据存储，比如Student对象，有很多以这个对象为核心的数据。二、使用2.1写一个Configpublic class SchooltConfig { private StudentConfig student1; private StudentConfig student2; private TeacherConfig teacher1; private TeacherConfig teacher2; //set get public SchooltConfig() { student1 = new StudentConfig(); student2 = new StudentConfig(); teacher1 = new TeacherConfig(); teacher2 = new TeacherConfig(); } public static class StudentConfig { int id String name; int age; // set get ...... } public static class TeacherConfig{ int id String name; int age; // set get ...... } }2.2存2.2.1数据存的使用private SchoolConfig.StudentConfig student1Config; private SchoolConfig.StudentConfig student2Config; student1Config= ConfigKeeper.Inst().schoolConfig.getStudent1Config; student2Config= ConfigKeeper.Inst().schoolConfig.getStudent2Config; student1Config.setId = 1； student1Config.setName = "张三"； student1Config.setAge = 16； student2Config.setId = 2； student2Config.setName = "李四"； student2Config.setAge = 18； //在onDestroy()或者其他地方存 ConfigKeeper.Inst().saveSchoolConfig();2.2.2写一个ConfigKeeper.java（其他工具类util见最后）public class ConfigKeeper { private String TAG = this.getClass().getName(); private SchoolConfig schoolConfig = new SchoolConfig(); private File schoolFile = null; private static ConfigKeeper inst = null; private boolean initialized = false; private ConfigKeeper() { initConfig(); } public static ConfigKeeper Inst() { if (inst == null) { inst = new ConfigKeeper(); } return inst; } public void initConfig() { synchronized (this) { if (!initialized) { schoolFile = getSchoolConfigFile(); if (schoolFile.exists()) { schoolConfig = new Gson().fromJson(IOUtils.readStr(schoolFile), SchoolConfig.class); if (schoolConfig == null) { schoolConfig = new SchoolConfig(); } } initialized = true; } } } public void saveSchoolConfig() { if (权限判断) { Log.e("TAG", "保存配置错误,未获取到写入文件权限") return; } if (schoolFile != null) { ThreadPool.getInstance().executeSingle(new Runnable() { @Override public void run() { if (schoolConfig != null) { String configJson = new Gson().toJson(schoolConfig); IOUtils.writeStr(schoolFile, configJson); } } }); } } public SchoolConfig getSchoolConfig() { return schoolConfig; } public void setSchoolConfig(SchoolConfig conf) { schoolConfig = conf; } private File getSchoolConfigFile() { return FileUtils.getFile("config", "school_config.json"); } } 2.3取//student1Config的实例看存 if (student1Config.getName != null) { String name = student1Config.getName; } ....三、注意    等我想到在写四、附链接    FileUtils、IOUtils、ThreadPool（还没写）