开发过程中的效率提升工具

为了更愉快的写代码，开发过程中常常需要一些功能类来提高工作效率，记录一下用到过的比较好的开发效率工具

1、java StopWatch统计时间

       有时候记录一段代码的执行时间，最常见的方法是打印当前的时间与执行后的差值，确定是使用很麻烦并且很不直观。spring-framework提供了一个stopWatch类可以做类似任务的执行时间控制。StopWath是apache commons lang3包下的一个任务执行时间监视器。

主要方法:

start();     //开始计时

split();     //设置split点

getSplitTime();  //获取从start 到 最后一次split的时间

reset();     //重置计时

suspend();     //暂停计时, 直到调用resume()后才恢复计时

resume();      //恢复计时

stop();      //停止计时

getTime();    //统计从start到现在的计时

例子：

package com.example.stopwatch;

import org.springframework.util.StopWatch;

public class StopWatchTest {

    private void test() throws InterruptedException {

        StopWatch sw = new StopWatch();

        sw.start("起床");

        Thread.sleep(1000);

        sw.stop();

        sw.start("洗漱");

        Thread.sleep(2000);

        sw.stop();

        sw.start("锁门");

        Thread.sleep(500);

        sw.stop();

        System.out.println(sw.prettyPrint());

        System.out.println(sw.getTotalTimeMillis());

        System.out.println(sw.getLastTaskName());

        System.out.println(sw.getLastTaskInfo());

        System.out.println(sw.getTaskCount());

    }

    public static void main(String []argv) throws InterruptedException {

        TestStopWatch testStopWatch = new TestStopWatch();

        testStopWatch.test();

    }

}

结果如下

实验结果

2、Swagger Api

可以无需手写，自动生成接口的API文档的工具

1、Maven依赖

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger2</artifactId>

    <version>2.2.2</version>

</dependency>

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger-ui</artifactId>

    <version>2.2.2</version>

</dependency>

2、配置类

/**

* Swagger2配置类

* 在与spring boot集成时，放在与Application.java同级的目录下。

* 通过@Configuration注解，让Spring来加载该类配置。

* 再通过@EnableSwagger2注解来启用Swagger2。

*/

@Configuration

@EnableSwagger2

publicclass Swagger2 {

/**

    * 创建API应用

    * apiInfo() 增加API相关信息

    * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，

    * 本例采用指定扫描的包路径来定义指定要建立API的目录。

    *

    * @return

    */

@Bean

public Docket createRestApi() {

returnnewDocket(DocumentationType.SWAGGER_2)

                .apiInfo(apiInfo())

                .select()

.apis(RequestHandlerSelectors.basePackage("com.swaggerTest.controller"))

                .paths(PathSelectors.any())

                .build();

    }

/**

    * 创建该API的基本信息（这些基本信息会展现在文档页面中）

    * 访问地址：http://项目实际地址/swagger-ui.html

    * @return

    */

private ApiInfo apiInfo() {

returnnewApiInfoBuilder()

.title("Spring Boot中使用Swagger2构建RESTful APIs")

.description("更多请关注http://www.baidu.com")

.termsOfServiceUrl("http://www.baidu.com")

.contact("sunf")

.version("1.0")

                .build();

    }

如上代码所示，通过createRestApi函数创建Docket的Bean之后，apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。

3、使用方法介绍

Swagger使用的注解及其说明：

@Api：用在类上，说明该类的作用。

@ApiOperation：注解来给API增加方法说明。

@ApiImplicitParams : 用在方法上包含一组参数说明。

@ApiImplicitParam：用来注解来给方法入参增加说明。

@ApiResponses：用于表示一组响应

@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

l code：数字，例如400

l message：信息，例如"请求参数没填好"

l response：抛出异常的类

@ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）

l @ApiModelProperty：描述一个model的属性

/**

* 一个用来测试swagger注解的控制器

* 注意@ApiImplicitParam的使用会影响程序运行，如果使用不当可能造成控制器收不到消息

*

*@authorSUNF

*/

@Controller

@RequestMapping("/say")

@Api(value ="SayController|一个用来测试swagger注解的控制器")

publicclass SayController {

@ResponseBody

@RequestMapping(value ="/getUserName", method= RequestMethod.GET)

@ApiOperation(value="根据用户编号获取用户姓名", notes="test: 仅1和2有正确返回")

@ApiImplicitParam(paramType="query", name ="userNumber", value ="用户编号", required =true, dataType ="Integer")

public String getUserName(@RequestParam Integer userNumber){

if(userNumber ==1){

return"张三丰";

        }

elseif(userNumber ==2){

return"慕容复";

        }

else{

return"未知";

        }

    }

@ResponseBody

@RequestMapping("/updatePassword")

@ApiOperation(value="修改用户密码", notes="根据用户id修改密码")

@ApiImplicitParams({

@ApiImplicitParam(paramType="query", name ="userId", value ="用户ID", required =true, dataType ="Integer"),

@ApiImplicitParam(paramType="query", name ="password", value ="旧密码", required =true, dataType ="String"),

@ApiImplicitParam(paramType="query", name ="newPassword", value ="新密码", required =true, dataType ="String")

    })

public String updatePassword(@RequestParam(value="userId") Integer userId, @RequestParam(value="password") String password,

@RequestParam(value="newPassword") String newPassword){

if(userId <=0|| userId >2){

return"未知的用户";

      }

if(StringUtils.isEmpty(password) || StringUtils.isEmpty(newPassword)){

return"密码不能为空";

      }

if(password.equals(newPassword)){

return"新旧密码不能相同";

      }

return"密码修改成功!";

    }

完成上述代码添加上，启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html

其他注意事项:

1、paramType会直接影响程序的运行期，如果paramType与方法参数获取使用的注解不一致，会直接影响到参数的接收。

2、Conntroller中定义的方法必须在@RequestMapper中显示的指定RequestMethod类型，否则SawggerUi会默认为全类型皆可访问， API列表中会生成多条项目。

工具类

所有的工具类，优先采用 apache commons 系列；

apache commons未提供的工具可以自行扩展，也应该是在其基础之上进行扩展，而不是另外实现

编码及加解密方法规范

应用中资源统一采用 UTF-8 编码，统一采用Spring提供的CharacterEncodingFilter来实现。

常见的加解密统一采用 apache commons-codec 库所提供的方法，具体 API 及文档参见：https://commons.apache.org/proper/commons-codec

关于金额类型的说明

应用中涉及到金额时，在系统、数据库设计的时候通常有两种做法：

1. Decimal 格式：（也是较通用的格式），数据库和Java中都有对应的类型支持；

优点：直观，在使用的过程中也无需转换。精度方面也支持得非常好，可以随时动态调整；

缺点：API 使用相对复杂一点，对应的 Java 对象为 BigDecimal ，做四则运算的时候都是对象方法调用；

2. Int 格式：通常按照一定的小数点留存数量乘以相应的倍数，将金额转换成分（美分）；

比如： 1.88 元 = 188 分

优点：数据类型简单，做四则运算时也比较快捷方便；

缺点：精度无法动态变换，在用户输入/展示与数据存储之间需要进行数据转换；

注：由于真正做运算的场景不多， 相关 API 也不会频繁的调用，所以根据以上的比较，规定本中心所有金额相关的数据类型，如无特殊原因需要说明外，统一采用 Decimal 数据格式；