疯狂java


您现在的位置: 疯狂软件 >> 新闻资讯 >> 正文

如何用JAVA写出无副作用的代码


 

   搞java的同学们可能对无副作用这个概念比较陌生,这是函数式编程中的一个概念,无副作用的意思就是: 一个函数(java里是方法)的多次调用中,只要输入参数的值相同,输出结果的值也必然相同,并且在这个函数执行过程中不会改变程序的任何外部状态(比如全局变量,对象中的属性,都属于外部状态),也不依赖于程序的任何外部状态。

  比如下面的两个方法,就可以认为是无副作用的。

  /**

  *

  * @author leo

  *

  */

  public class NoSideEffect {

  public static int add(int a, int b) {

  return a+b;

  }

  public boolean isEmpty(String s) {

  if (s == null || s.trim().length() == 0) {

  return true;

  }

  return false;

  }

  }

  下面是有副作用的例子:

  /**

  *

  * @author leo

  *

  */

  public class HasSideEffect {

  public int baseValue;

  public int getCount(int addtion) {

  return baseValue + addtion;

  }

  }

  无副作用的要求可以很严格,在Fp(functional programing)的语言如lisp clojure中,无副作用的方法中连print都不能有,因为他们认为连屏幕也是外部状态,我个人觉得在写java的无副作用代码时,可以放宽一点,这个度可以自己把握,自己用着爽就ok。

  “线程安全”是java中一个比较常见的概念,线程安全的类,是说不管多少个线程并发访问这个对象,都不会发生不可预期的错误,他们的表现跟单线程访问时一样,是安全可靠的。 无副作用和线程安全的概念有相似之处,无副作用的方法,一定是线程安全的,这两个概念都能够帮助写出并发友好的代码,无副作用的编程还有一个好处,代码会很清爽,因为这个方法里的代码只跟输入输出有关系, 习惯了写无副作用的代码,能够设计出更稳健的程序。 大家可以想象,如果一个系统的代码,到处是状态,到处有千丝万缕的联系,这个系统的可维护性会是怎么样的,写过几年代码的人,可能都会碰到过这种让人头疼的项目。

  下面介绍几点我个人积累的关于java无副作用编程的经验:

  1. 使用静态方法

  我经常把一些常用的工具方法,甚至小项目中的业务方法写成utils类的静态方法,这些方法尽量写成无副作用的,这样的结果是,数据和操作分开,我感觉用起来比较好。

  1 public class AgentUtils {

  2

  3 private static long lastMsgIdTime = 0L;

  4

  5 public static synchronized String createNewMsgId(String clientId) {

  6 long now = System.currentTimeMillis();

  7 if (now <= lastMsgIdTime) {

  8 now = lastMsgIdTime + 1;

  9 }

  10 Date nowTime = new Date(now);

  11 String timeStr = DateFormatUtils.format(nowTime, "yyyyMMddHHmmssSSS");

  12 lastMsgIdTime = now;

  13 return clientId + "_" + timeStr;

  14 }

  15

  16 public static TASK_REPORT_req createTaskReportAndUpdateLocalState(TASK_ASSIGN_req task, WorkItemState workItemState) {

  17 TASK_REPORT_req req = new TASK_REPORT_req(MsgType.TASK_REPORT);

  18 req.imei = task.imei;

  19 req.taskId = task.taskId;

  20 req.testType = task.testType;

  21 req.workItemState = workItemState;

  22 TaskQueue.updateLocalTestWorkState(req.taskId, req.imei, workItemState);

  23 return req;

  24 }

  25

  26 // private static Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd HH:mm:ss:SSS").create();

  27

  28 public static Meta getMeta(String message) {

  29 Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd HH:mm:ss:SSS").create();

  30 BaseMsg warp = gson.fromJson(message, BaseMsg.class);

  31 return warp.meta;

  32 }

  33

  34 public static Gson getGson() {

  35 Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd HH:mm:ss:SSS").create();

  36 return gson;

  37 }

  38

  39 /**

  40 * @param LocalOrRemote 0 :local 1:remote

  41 * @param serverApkPath

  42 * @return

  43 */

  44 public static String downloadAPK(int LocalOrRemote, String serverApkPath, String taskId) throws IOException {

  45 File src = new File(serverApkPath);

  46 String localFileName = buildFullPath(AgentConf.i.apk_file_base_dir, taskId + "_" + src.getName());

  47

  48 //使用scp实现下载

  49 if (LocalOrRemote == 0) {

  50 FileUtils.copyFileToDirectory(src, new File(AgentConf.i.apk_file_base_dir));

  51 return localFileName;

  52 }

  53 //remote 使用scp实现下载

  54 boolean isShellSuccess = false;

  55

  56 String shell = AgentConf.i.apk_download_cmd + " " + AgentConf.i.server_ip + " " + serverApkPath + " " + localFileName;

  57 AgentMain.log.info("exec shell:" + shell);

  58 int returncode;

  59 try {

  60 returncode = Runtime.getRuntime().exec(shell).waitFor();

  61 } catch (InterruptedException e) {

  62 e.printStackTrace();

  63 return null;

  64 }

  65 AgentMain.log.info("shell returncode:" + returncode);

  66

  67 isShellSuccess = returncode == 0;

  68

  69 // 检查是否成功,修改queue中状态

  70 if (isShellSuccess) {

  71 return localFileName;

  72 } else {

  73 return null;

  74 }

  75 }

  76 /**

  77 *

  78 * @param LocalOrRemote 0 :local 1:remote

  79 * @param localReprotPaht

  80 * @param serverReportPath

  81 * @throws IOException

  82 */

  83

  84 public static void uploadReport(int LocalOrRemote, String localReprotPaht, String serverReportPath) throws IOException {

  85 //使用scp实现下载

  86 if (LocalOrRemote == 0) {

  87 FileUtils.copyFile(new File(localReprotPaht), new File(serverReportPath));

  88 return;

  89 }

  90 //remote 使用scp实现下载

  91

  92 String shell = AgentConf.i.report_upload_cmd + " " + AgentConf.i.server_ip + " " + localReprotPaht + " " + serverReportPath;

  93 AgentMain.log.info("exec shell:" + shell);

  94 int returncode;

  95 try {

  96 returncode = Runtime.getRuntime().exec(shell).waitFor();

  97 } catch (InterruptedException e) {

  98 throw new IOException(e.getMessage(), e);

  99 }

  100 AgentMain.log.info("shell returncode:" + returncode);

  101 return;

  102 }

  103 }

  这种做法破坏了面向对象编程的原则,不过我觉得面向对象和面向过程,函数式编程都是工具,不是宗教,不需要严格的遵守,如果发现了更适合自己的工具,不用去死守原则。

  2. 不可变对象

  所有字段都设置成final的,只许赋值一次,保证对象不会被改变

  1 /**

  2 *

  3 * @author leo

  4 *

  5 */

  6 public class TaskData {

  7 public TaskData(long taskId, String pkgName,Date updatedAt) {

  8 this.taskId = taskId;

  9 this.pkgName = pkgName;

  10 if (updatedAt == null) {

  11 SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

  12 try {

  13 updatedAt = sdf.parse("2001-01-01 01:01:01");

  14 } catch (ParseException e) {

  15 Main.log.error(e);

  16 }

  17 }

  18 this.updatedAt = updatedAt;

  19

  20 }

  21 public final long taskId;

  22 public final String pkgName;

  23 /**最后一次处理的时间*/

  24 public final Date updatedAt;

  25 public final Date now = new Date();

  26

  27 @Override

  28 public String toString() {

  29 return "TaskData[taskId:" + this.taskId + ",pkgName:" + this.pkgName + "]";

  30 }

  31 }

  这是一种极端的防止副作用出现的做法,实际应用中可以做些妥协,自己意识到就好了。

  3. 考究的设计,克制的写代码

  呵呵,这一条好像跟废话一样。不管是面向什么编程模式,软件设计本身更重要,没有好的设计抽象,不可能写出好代码,架构代码和业务代码要有清晰的划分,业务和业务之间的代码尽量的减少耦合,不要写出有千丝万缕联系的代码, 这些都是设计的原则, 无副作用编程 也一样,只是一个帮助做出好设计的编程原则, 我一直觉得,设计就是约束, 好的设计,就是要不断的给整个系统的代码添加约束,某个地方,不能做什么,某个地方,只能做什么, 如果没有约束,谁谁都可以上天入地,这不可能是一个好维护的软件。

  关于设计,我给不出具体的代码,对自己代码有追求的人,会不断提高自己做设计的能力,没有追求的人,你手把手教他他都会觉得你烦。

  关于无副作用编程,感觉想说的不少,能说清楚的不多,建议写java的同学们能学一门动态语言或者函数式编程的语言,比如ruby python clojure,有挺多值得我们借鉴,瞎写瞎看吧 呵呵,欢迎拍砖,等有新想法了我再来完善。