#Java# 文章列表 Java 安装 Java:第一个程序 Hello World Java:建议使用 UTF-8 编写 Java 代码 Java:package 包命名规范 使用 Intellij IDEA 创建 Java 项目 Java 布尔类型 Java 处理日期和时间 Java 正则表达式 Java finalize 方法 Java:空值 null Java 如何触发垃圾回收 Java ThreadLocal Java InheritableThreadLocal Java Integer之间的比较 Java 动态代理 Java 匿名类 Java 枚举 Java 如何静态导入 import static println Java 引用级别:强引用、软引用、弱引用、幽灵引用 Java try finally return 解惑 Java WeakHashMap Java ReferenceQueue 怎么写 Java 示例代码? Java 匿名类双大括号初始化 什么是 Java Bean Java 多行字符串 Java 快速生成 List Java 快速生成 Map Java 将异常堆栈转换为 String JDK SPI 的使用和源码分析 Java Map 中的 key 和 value 能否为 null ? Java List 和 数组的互相转换 Java 获取环境变量 Java 获取和设置系统属性 Java:如何获取当前进程的 PID ? Java 字符串左侧 右侧补充空格或者其他字符 Java 线程 Java:如何获取文本文件内容 Java:读取资源文件内容 Java:使用 JavaFx 构建 GUI Java:Class 类 Java:使用 instanceof 判断对象类型 一个自定义的 Java 工具类 Java:获取当前函数所属类的类名 Java:获取当前执行的函数名 Java:使用 String 的 split 函数拆分字符串 Java:获取字符的 Unicode 编号(代码点) Java:获取当前工作目录 Java:使用 Class 对象的 isArray 方法判断对象是否为数组 使用 Java 生成 CSV 文件 Java Mockito 测试框架快速入门 JUnit 入门 JUnit 单测隔离 Java JOOR 反射库 Java alibaba transmittable-thread-local 库:让 ThreadLocal 跨线程传播 Java 日志组件 slf4j 的使用和源码分析 Java Lombok 库:为你减少样板代码 Java:使用 cglib 实现动态代理 Java Hibernate validator 校验框架 Java 使用 Hessian2 序列化和反序列化 H2 数据库快速入门 Java:使用 Gson 库处理 JSON 数据 Java 集成 groovy 构建规则引擎 Java 13:安装 Java 13 新特性:文本块(多行字符串) 卸载 MacOS 上安装的 Java Java:执行 sql 文件 Java JDK 有哪些发行版 ? java拾遗:String和数组 java拾遗:由反转数组想到System.out的实现机制 java拾遗:如何读取properties文件内容 Java并发概念汇总 java拾遗:System.out.println()是什么? java拾遗:通过示例理解位运算 使用“庖丁解牛”进行中文分词 DBUtils简明教程 试用velocity模板引擎 Java:将字符串哈希为数字 kafka SnappyError no native library is found 问题

怎么写 Java 示例代码?


#Java#


为什么写示例代码?

1、自己写了一些Java代码,通过示例告诉别人该怎么用。

2、看到神奇的Java项目,通过编写示例学习怎么用。

对于我,最开始用的是下面的方案1。

方案1:创建类,然后写main函数

在类中写几个static函数,在 main 函数中有选择的调用,然后执行代码,看运行结果。运行结果来自哪里?来自System.out.println

但是这种方式要经常更换 main 函数中的代码。所以,后来优化为,写多个类,每个类都有 main 函数,尽量保证代码少改动。这也有问题,就是类太多。

后来,在用 junit 写了一堆单元测试代码后,我发现 junit 可以完美应对写示例代码的需求。

方案2:使用 junit 单元测试框架

我现在用的 Intellij IDEA IDE 很好的集成了junit。在一个类中写一堆用@Test注解的函数,随便一个函数中鼠标右击,就有执行这个函数的选项。

举个简单的使用示例。

第一步,用 Intellij IDEA 创建一个基于 gradle 的 java 项目。

第二步,将 build.gradle 中依赖

dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.12'
}

修改为:

dependencies {
    compile group: 'junit', name: 'junit', version: '4.12'
}

我们的目的不是写单测代码,而是示例代码。把testCompile改成compile,这样就可以在main/java目录中使用 junit 了。

第三步,写个示例:

import org.junit.Test;

public class Demo {

    @Test
    public void test_01() {
        System.out.println(1+1);
    }

    @Test
    public void test_02() {
        System.out.println(1+2);
    }

}

搞定。

方案3:在方案2的基础上引入lombok和slf4j

lombok和slf4j的使用可以参考我的这两篇文章:

对于这个方案,build.gradle 中的依赖配置如下:

compile group: 'org.projectlombok', name: 'lombok', version: '1.18.0'

compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.25'
compile group: 'org.slf4j', name: 'slf4j-log4j12', version: '1.7.25'
compile group: 'log4j', name: 'log4j', version: '1.2.17'

compile group: 'junit', name: 'junit', version: '4.12'

在 resources 目录中增加 log4j 的配置文件log4j.properties,内容如下:

log4j.rootLogger=INFO, stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

可根据需要修改。

方案4: 自定义 log 函数

方案3中引入了日志框架,但是配置起来有点麻烦。我们可以自定义一个日志方法。可参考 一个自定义的 Java 工具类


( 本文完 )