OO第三单元——JML——总结

一、JML的梳理和总结

JML

简介

JML（JAVA Modeling Language)是用于对JAVA程序进行规格化设计的一种表示语言。一般具有两种用法：
- 开展规格化设计。其特征为：严格的逻辑性。
- 针对已有的代码实现。书写对应规格，从而提高代码的可维护性。

基本表达式结构

原子表达式

表达式	含义
\result	方法执行后的返回值
\old(expr)	一个表达式expr在相应方法执行前的取值
\not_assigned(x,y,...)	限制一个方法的实现不能对列表中的变量进行赋值
\not_modified(x.y,...)	限制括号中的变量在方法执行期间的取值未发生变化
\nonnullelements(container)	container对象中存储的对象不会有null
\type(type)	返回类型type对应的类型（class）
\typeof(expr)	返回expr对应的准确类型

量化表达式

表达式	含义
\forall	表示对于给定范围内的元素，每个元素都满足相应的约束
\exists	表示对于给定范围内的元素，存在某个元素满足相应的约束
\sum	返回给定范围内的表达式的和
\product	返回给定范围内的表达式的连乘结果
\max	返回给定范围内的表达式的最大值
\min	返回给定范围内的表达式的最小值
\num_of	返回指定变量中满足相应条件的取值个数

集合表达式

表达式	含义
new ST {T x\|R(x)&&P(x)},其中的R(x)对应集合中x的范围	明确集合中可以包含的元素

操作符

表达式	含义
E1<:E2	子类型关系操作符，若为子类型，则为真
b_expr1<==>b_expr2或b_expr1<=!=>b_expr2	等价关系操作符，与java中的==和!=具有相同的效果，优先级更低
b_expr1==>b_expr2	推理操作符，与离散一致
\nothing \everything	变量引用操作符，经常与assignable共同使用

规格

扫描二维码关注公众号，回复： 11254068 查看本文章

正常行为规格（normal_behavior)
- 前置条件（pre_condition)
  
  通过requires子句来表示：requires P；表达意思是“要求调用者确保P为真”，多个requires子句呈并列关系。
- 后置条件（post_condition）
  
  后置条件通过ensures子句来表示：ensures P；表达的意思是“方法实现者确保方法执行返回结果一定满足谓词P的要求,即确保P为真”,同样为并列关系。
- 副作用范围限定（side_effects)
  
  副作用指方法在执行过程中会修改对象的属性数据或者类的静态成员数据，从而给后续方法的执行带来影响。JML提供了副作用约束子句，使用关键词assignable 或者 modifiable 。
```
	/*@
	@ ...
	@ assignable \nothing;
	@ assignable \everything;
	@ modifiable elements;
	@*/
```
  设计中会出现某些纯粹访问性的方法，即不会对对象的状态进行任何改变，也不需要提供输入参数，这样的方法无需描述前置条件，也不会有任何副作用，且执行一定会正常结束。对于这类方法，可以使用简单的（轻量级）方式来描述其规格，即使用 pure 关键词。
```
public /*@ pure @*/ String getName();
public /*@ pure @*/ int getCredits;
```

异常行为规格（exceptional_behavior)

signals子句

表达式	含义
signals (***Exception e) b_expr;	当b_expr 为 true 时方法会抛出对应异常e
signals_only b_expr;	不强调对象状态条件，强调满足前置条件时抛出相应异常

JML工具链

OpenJML

用于检查JML文档规格语法。

下载地址：http://www.openjml.org/
JMLUnitNG/JMLUnit

基于JML的单元测试工具，能够自动生成测试用例，注重边界条件的测试。

下载地址：http://insttech.secretninjaformalmethods.org/software/jmlunitng/

二、SMT Solver

OpenJML

执行语句

java -jar openjml.jar -exec Solvers/z3-4.7.1.exe -esc src/*.java

得到

发现了很多东西完全测不了，只好测Person.java

 java -jar openjml.jar -exec Solvers-windows/z3-4.7.1.exe -esc src/Person.java

虽然有很多警告，但总算能跑通了。

三、JMLUnit

JMLUnitNG

文件树如图，然后执行下列4条语句。

java -jar jmlunitng.jar test/Person.java

javac -cp jmlunitng.jar test/*.java

java -jar openjml.jar -rac test/Person.java

java -cp jmlunitng.jar test.Person_JML_Test

得到如下结果：

Passed: racEnabled()
Failed: constructor Person(-2147483648, null, null, -2147483648)
Failed: constructor Person(0, null, null, -2147483648)
Failed: constructor Person(2147483647, null, null, -2147483648)
Failed: constructor Person(-2147483648, , null, -2147483648)
Failed: constructor Person(0, , null, -2147483648)
Failed: constructor Person(2147483647, , null, -2147483648)
Failed: constructor Person(-2147483648, null, null, 0)
Failed: constructor Person(0, null, null, 0)
Failed: constructor Person(2147483647, null, null, 0)
Failed: constructor Person(-2147483648, , null, 0)
Failed: constructor Person(0, , null, 0)
Failed: constructor Person(2147483647, , null, 0)
Failed: constructor Person(-2147483648, null, null, 2147483647)
Failed: constructor Person(0, null, null, 2147483647)
Failed: constructor Person(2147483647, null, null, 2147483647)
Failed: constructor Person(-2147483648, , null, 2147483647)
Failed: constructor Person(0, , null, 2147483647)
Failed: constructor Person(2147483647, , null, 2147483647)
Skipped: <<null>>.compareTo(null)
Skipped: <<null>>.equals(null)
Skipped: <<null>>.equals(java.lang.Object@29444d75)
Skipped: <<null>>.getAcq(-2147483648)
Skipped: <<null>>.getAcq(0)
Skipped: <<null>>.getAcq(2147483647)
Skipped: <<null>>.getAcquaintanceSum()
Skipped: <<null>>.getAge()
Skipped: <<null>>.getCharacter()
Skipped: <<null>>.getId()
Skipped: <<null>>.getName()
Skipped: <<null>>.isLinked(null)
Skipped: <<null>>.queryValue(null)

===============================================
Command line suite
Total tests run: 32, Failures: 18, Skips: 13
===============================================

可以看到验证并不随机，只基于了边界数据的考量，不具有一般性，经过魔改Person类后，跑完的结果是：

Passed: racEnabled()
Failed: constructor Person(-2147483648, null, -2147483648)
Failed: constructor Person(0, null, -2147483648)
Failed: constructor Person(2147483647, null, -2147483648)
Passed: constructor Person(-2147483648, , -2147483648)
Passed: constructor Person(0, , -2147483648)
Passed: constructor Person(2147483647, , -2147483648)
Failed: constructor Person(-2147483648, null, 0)
Failed: constructor Person(0, null, 0)
Failed: constructor Person(2147483647, null, 0)
Passed: constructor Person(-2147483648, , 0)
Passed: constructor Person(0, , 0)
Passed: constructor Person(2147483647, , 0)
Failed: constructor Person(-2147483648, null, 2147483647)
Failed: constructor Person(0, null, 2147483647)
Failed: constructor Person(2147483647, null, 2147483647)
Passed: constructor Person(-2147483648, , 2147483647)
Passed: constructor Person(0, , 2147483647)
Passed: constructor Person(2147483647, , 2147483647)
Passed: <<test.Person@3f102e87>>.addAcq(null)
Passed: <<test.Person@5f5a92bb>>.addAcq(null)
Passed: <<test.Person@6fdb1f78>>.addAcq(null)
Passed: <<test.Person@51016012>>.addAcq(null)
Passed: <<test.Person@29444d75>>.addAcq(null)
Passed: <<test.Person@2280cdac>>.addAcq(null)
Passed: <<test.Person@1517365b>>.addAcq(null)
Passed: <<test.Person@4fccd51b>>.addAcq(null)
Passed: <<test.Person@60215eee>>.addAcq(null)
Passed: <<test.Person@4ca8195f>>.addValue(-2147483648)
Passed: <<test.Person@65e579dc>>.addValue(-2147483648)
Passed: <<test.Person@61baa894>>.addValue(-2147483648)
Passed: <<test.Person@b065c63>>.addValue(-2147483648)
Passed: <<test.Person@768debd>>.addValue(-2147483648)
Passed: <<test.Person@490d6c15>>.addValue(-2147483648)
Passed: <<test.Person@7d4793a8>>.addValue(-2147483648)
Passed: <<test.Person@449b2d27>>.addValue(-2147483648)
Passed: <<test.Person@5479e3f>>.addValue(-2147483648)
Passed: <<test.Person@27082746>>.addValue(0)
Passed: <<test.Person@66133adc>>.addValue(0)
Passed: <<test.Person@7bfcd12c>>.addValue(0)
Passed: <<test.Person@42f30e0a>>.addValue(0)
Passed: <<test.Person@24273305>>.addValue(0)
Passed: <<test.Person@46f5f779>>.addValue(0)
Passed: <<test.Person@18e8568>>.addValue(0)
Passed: <<test.Person@33e5ccce>>.addValue(0)
Passed: <<test.Person@5a42bbf4>>.addValue(0)
Passed: <<test.Person@270421f5>>.addValue(2147483647)
Passed: <<test.Person@52d455b8>>.addValue(2147483647)
Passed: <<test.Person@4f4a7090>>.addValue(2147483647)
Passed: <<test.Person@18ef96>>.addValue(2147483647)
Passed: <<test.Person@6956de9>>.addValue(2147483647)
Passed: <<test.Person@769c9116>>.addValue(2147483647)
Passed: <<test.Person@6aceb1a5>>.addValue(2147483647)
Passed: <<test.Person@2d6d8735>>.addValue(2147483647)
Passed: <<test.Person@ba4d54>>.addValue(2147483647)
Failed: <<test.Person@12bc6874>>.compareTo(null)
Failed: <<test.Person@de0a01f>>.compareTo(null)
Failed: <<test.Person@4c75cab9>>.compareTo(null)
Failed: <<test.Person@1ef7fe8e>>.compareTo(null)
Failed: <<test.Person@6f79caec>>.compareTo(null)
Failed: <<test.Person@67117f44>>.compareTo(null)
Failed: <<test.Person@5d3411d>>.compareTo(null)
Failed: <<test.Person@2471cca7>>.compareTo(null)
Failed: <<test.Person@5fe5c6f>>.compareTo(null)
Passed: <<test.Person@763d9750>>.equals(null)
Passed: <<test.Person@5c0369c4>>.equals(null)
Passed: <<test.Person@2be94b0f>>.equals(null)
Passed: <<test.Person@d70c109>>.equals(null)
Passed: <<test.Person@17ed40e0>>.equals(null)
Passed: <<test.Person@50675690>>.equals(null)
Passed: <<test.Person@31b7dea0>>.equals(null)
Passed: <<test.Person@3ac42916>>.equals(null)
Passed: <<test.Person@47d384ee>>.equals(null)
Passed: <<test.Person@3930015a>>.equals(java.lang.Object@629f0666)
Passed: <<test.Person@1bc6a36e>>.equals(java.lang.Object@1ff8b8f)
Passed: <<test.Person@387c703b>>.equals(java.lang.Object@224aed64)
Passed: <<test.Person@c39f790>>.equals(java.lang.Object@71e7a66b)
Passed: <<test.Person@2ac1fdc4>>.equals(java.lang.Object@5f150435)
Passed: <<test.Person@1c53fd30>>.equals(java.lang.Object@50cbc42f)
Passed: <<test.Person@282ba1e>>.equals(java.lang.Object@13b6d03)
Passed: <<test.Person@f5f2bb7>>.equals(java.lang.Object@73035e27)
Passed: <<test.Person@5474c6c>>.equals(java.lang.Object@4b6995df)
Failed: <<test.Person@591f989e>>.getAcq(-2147483648)
Failed: <<test.Person@66048bfd>>.getAcq(-2147483648)
Failed: <<test.Person@61443d8f>>.getAcq(-2147483648)
Failed: <<test.Person@445b84c0>>.getAcq(-2147483648)
Failed: <<test.Person@61a52fbd>>.getAcq(-2147483648)
Failed: <<test.Person@233c0b17>>.getAcq(-2147483648)
Failed: <<test.Person@63d4e2ba>>.getAcq(-2147483648)
Failed: <<test.Person@7bb11784>>.getAcq(-2147483648)
Failed: <<test.Person@33a10788>>.getAcq(-2147483648)
Failed: <<test.Person@7006c658>>.getAcq(0)
Failed: <<test.Person@34033bd0>>.getAcq(0)
Failed: <<test.Person@47fd17e3>>.getAcq(0)
Failed: <<test.Person@7cdbc5d3>>.getAcq(0)
Failed: <<test.Person@3aa9e816>>.getAcq(0)
Failed: <<test.Person@17d99928>>.getAcq(0)
Failed: <<test.Person@1ae369b7>>.getAcq(0)
Failed: <<test.Person@6fffcba5>>.getAcq(0)
Failed: <<test.Person@34340fab>>.getAcq(0)
Failed: <<test.Person@2aafb23c>>.getAcq(2147483647)
Failed: <<test.Person@2b80d80f>>.getAcq(2147483647)
Failed: <<test.Person@3ab39c39>>.getAcq(2147483647)
Failed: <<test.Person@2eee9593>>.getAcq(2147483647)
Failed: <<test.Person@7907ec20>>.getAcq(2147483647)
Failed: <<test.Person@546a03af>>.getAcq(2147483647)
Failed: <<test.Person@721e0f4f>>.getAcq(2147483647)
Failed: <<test.Person@28864e92>>.getAcq(2147483647)
Failed: <<test.Person@6ea6d14e>>.getAcq(2147483647)
Passed: <<test.Person@6ad5c04e>>.getAcquaintanceSum()
Passed: <<test.Person@6833ce2c>>.getAcquaintanceSum()
Passed: <<test.Person@725bef66>>.getAcquaintanceSum()
Passed: <<test.Person@2aaf7cc2>>.getAcquaintanceSum()
Passed: <<test.Person@6e3c1e69>>.getAcquaintanceSum()
Passed: <<test.Person@1888ff2c>>.getAcquaintanceSum()
Passed: <<test.Person@35851384>>.getAcquaintanceSum()
Passed: <<test.Person@649d209a>>.getAcquaintanceSum()
Passed: <<test.Person@6adca536>>.getAcquaintanceSum()
Passed: <<test.Person@357246de>>.getAge()
Passed: <<test.Person@28f67ac7>>.getAge()
Passed: <<test.Person@256216b3>>.getAge()
Passed: <<test.Person@2a18f23c>>.getAge()
Passed: <<test.Person@d7b1517>>.getAge()
Passed: <<test.Person@16c0663d>>.getAge()
Passed: <<test.Person@23223dd8>>.getAge()
Passed: <<test.Person@4ec6a292>>.getAge()
Passed: <<test.Person@1b40d5f0>>.getAge()
Passed: <<test.Person@ea4a92b>>.getId()
Passed: <<test.Person@3c5a99da>>.getId()
Passed: <<test.Person@47f37ef1>>.getId()
Passed: <<test.Person@5a01ccaa>>.getId()
Passed: <<test.Person@71c7db30>>.getId()
Passed: <<test.Person@19bb089b>>.getId()
Passed: <<test.Person@4563e9ab>>.getId()
Passed: <<test.Person@11531931>>.getId()
Passed: <<test.Person@5e025e70>>.getId()
Passed: <<test.Person@1fbc7afb>>.getName()
Passed: <<test.Person@45c8e616>>.getName()
Passed: <<test.Person@4cdbe50f>>.getName()
Passed: <<test.Person@66d33a>>.getName()
Passed: <<test.Person@7cf10a6f>>.getName()
Passed: <<test.Person@7e0babb1>>.getName()
Passed: <<test.Person@6debcae2>>.getName()
Passed: <<test.Person@5ba23b66>>.getName()
Passed: <<test.Person@2ff4f00f>>.getName()
Failed: <<test.Person@c818063>>.isLinked(null)
Failed: <<test.Person@3f0ee7cb>>.isLinked(null)
Failed: <<test.Person@75bd9247>>.isLinked(null)
Failed: <<test.Person@7d417077>>.isLinked(null)
Failed: <<test.Person@7dc36524>>.isLinked(null)
Failed: <<test.Person@35bbe5e8>>.isLinked(null)
Failed: <<test.Person@2c8d66b2>>.isLinked(null)
Failed: <<test.Person@5a39699c>>.isLinked(null)
Failed: <<test.Person@3cb5cdba>>.isLinked(null)
Passed: <<test.Person@56cbfb61>>.queryValue(null)
Passed: <<test.Person@1134affc>>.queryValue(null)
Passed: <<test.Person@d041cf>>.queryValue(null)
Passed: <<test.Person@129a8472>>.queryValue(null)
Passed: <<test.Person@1b0375b3>>.queryValue(null)
Passed: <<test.Person@2f7c7260>>.queryValue(null)
Passed: <<test.Person@2d209079>>.queryValue(null)
Passed: <<test.Person@6bdf28bb>>.queryValue(null)
Passed: <<test.Person@6b71769e>>.queryValue(null)

===============================================
Command line suite
Total tests run: 163, Failures: 54, Skips: 0
===============================================

发现fail的点都是由于null，而null本身也不在设计范围内，因此经过分析测试是成功的，此时的文件树为：

C:.
│  PackageStrategy_int.class
│  PackageStrategy_int.java
│  PackageStrategy_java_lang_Object.class
│  PackageStrategy_java_lang_Object.java
│  PackageStrategy_java_lang_String.class
│  PackageStrategy_java_lang_String.java
│  PackageStrategy_test_Person.class
│  PackageStrategy_test_Person.java
│  Person.class
│  Person.java
│  Person_InstanceStrategy.class
│  Person_InstanceStrategy.java
│  Person_JML_Test.class
│  Person_JML_Test.java
│
└─Person_JML_Data
        addAcq__Person_person__5__person.class
        addAcq__Person_person__5__person.java
        addValue__int_x__0__x.class
        addValue__int_x__0__x.java
        ClassStrategy_int.class
        ClassStrategy_int.java
        ClassStrategy_java_lang_Object.class
        ClassStrategy_java_lang_Object.java
        ClassStrategy_java_lang_String.class
        ClassStrategy_java_lang_String.java
        ClassStrategy_test_Person.class
        ClassStrategy_test_Person.java
        compareTo__Person_p2__5__p2.class
        compareTo__Person_p2__5__p2.java
        equals__Object_obj__10__obj.class
        equals__Object_obj__10__obj.java
        getAcq__int_x__0__x.class
        getAcq__int_x__0__x.java
        isLinked__Person_person__5__person.class
        isLinked__Person_person__5__person.java
        Person__int_id__String_name__int_age__10__age.class
        Person__int_id__String_name__int_age__10__age.java
        Person__int_id__String_name__int_age__10__id.class
        Person__int_id__String_name__int_age__10__id.java
        Person__int_id__String_name__int_age__10__name.class
        Person__int_id__String_name__int_age__10__name.java
        queryValue__Person_person__5__person.class
        queryValue__Person_person__5__person.java

四、梳理作业架构设计

由于这次作业架构完全依据课程组的规定，也没有自己创建新的类，类图不再给出。

第九次作业

第一次JML作业可以讨论的不多，主要分为几点：

容器问题

在这一次作业中，MyNetwork和Myperson类中我都使用Arraylist作为容器存储，第一个原因是因为这一次作业所实现的功能比较简单，基本按照规格照搬即可，除了iscircle函数，课程组给的数据范围也没有太限制时间和空间，所以直接采用了Arraylist。
iscircle的实现问题

这一次作业由于数据弱的原因，再加上写惯了DFS，采用了DFS，但在截止之后注意到DFS在数据过大时，可能会造成内部栈overflow的问题，时间复杂度也是O(n^2)，在第二次作业中进行了修改。

Method ev(G) iv(G) v(G)

com.oocourse.spec1.main.MyNetwork.circle(int,int) 4.0 4.0 8.0

可以看出，iscircle的实现确实过于臃肿。
O(1)还是遍历？

有许多函数是关于类本身的一些参数进行求值的，既可以在addPerson或addRelation的时候进行update再O(1)查询，也可以调用函数时再进行计算，在时间限制不大的时候我选择了后者，也导致了第十次作业的TLE。

Method	ev(G)	iv(G)	v(G)
com.oocourse.spec1.main.MyNetwork.circle(int,int)	4.0	4.0	8.0

第十次作业

这一次作业加入了Group，变得比第九次作业复杂了些。

一些取舍

首先是上文提到的O(1)还是遍历的问题。对于relationsum，valuesum和conflictsum，我本想采用维护+查询的方式，但对于agemean和agevar，由于整除的特殊性，每一次的维护可能会出现问题，所以为了统一性，我舍弃了维护的方法，采用了遍历，在互测中出现了bug，在后文会详细说明。
容器的更换

由于对people的查询次数增加，再加上时间限制，将arraylist改成了hashmap，用id作为唯一索引。

第十一次作业

这一次作业的重要改变是多了算法层面的考察，对时间的限制显得格外重要。问题非常多。

最短路径

使用了spfa算法，结果非常惨烈，多条强测点被卡。
querystronglink

想法是先找出一条路径，然后删掉再进行判断是否连通，找路径图方便直接使用了spfa算法，导致了连环tle。

queryblocksum

非常傻兮兮的每次计算连通块的个数，导致时间复杂度非常的高。

com.oocourse.spec3.main.MyNetwork.updateBlockSum()	4.0	8.0	8.0
com.oocourse.spec3.main.MyNetwork.queryStrongLinked(int,int)	5.0	6.0	7.0

可以看出，方法的选择具有很大的问题。

五、分析bug及修复情况

第九次作业

未出现bug。

互测由于简单也未找到bug。

第十次作业

强测wa了一个点，互测相关的点也wa了。

解决方法是把relationsum和valuesum，conflictsum的遍历O(n^2)方式改为了维护+查询的方式，降到了O(n)。这个地方的出错也让我第一次明白不能死板地照着规格写代码。

互测同group错的地方主要是relationsum和valuesum更新的时候出错，产生了wronganswer。

第十一次作业

强测错太多了，未进互测。

强测爆炸后我查询资料知道了spfa算法时间复杂度的不确定性，在面对稠密图时其O（VE）的复杂度和dij+堆优化相比差太多，同时题设本身也没有给负路径，本就应该选择dij+堆优化的方式。

更改措施有以下几个：

舍弃了spfa算法，改成了dij+堆优化的方式。
对blocksum的计算没有再使用updateblocksum对全图进行计算连通块的办法，变成了增加点则blocksum++，增加边时判断两个点之前是否相连，若相连则blocksum--。
qsl寻找路径时同时也舍弃了spfa寻找路径，改成了dij+堆优化寻找。

六、心得体会

对JML的作用的感悟

JML作为规范化编程，给编程可以进行形式化验证提供了一种可能性，我们也可以使用工具分析JML进而进行自动化测试。但它现在远不够成熟，我们一单元的学习也只能算作管中窥豹，但它足以让我们养成一种注重规范化编程的习惯，注重数据边界、异常等。
对作业中出现的数据结构的感悟

自我认知在去年的数据结构上学的不是很好，图、表之类的知识掌握的非常薄弱，分数还好但确实没有暴露问题。第十一次作业做的时候发现需要使用一些算法的知识时我显得一筹莫展，疯狂在网上找板子。这个单元的最后结果也算是给我敲响了警钟，算法的学习永远不能停止。

OO第三单元——JML——总结

OO第三单元——JML——总结

猜你喜欢