Tiny-Mock

简介

tiny-mock是一个轻量mock框架，主要为了实现mock与真实代码解耦。

特性

tiny-mock 分本地mock（local-mock）和服务mock（server-mock）。
如果只为了在调用某一个接口时，不走真实逻辑，而走本地的mock分支的话，使用local-mock就能够满足你的要求。
如果想在调用某一个接口时，不走真实逻辑，而去调用一个第三方的mock服务的话，那么就要使用local-mock配合server-mock一起使用，就能够达到目的。

local-mock 提供本地mock的轻量实现
server-mock 提供服务mock的轻量实现
mock支持注解和xml配置两种方式，可以随意选择

I. local-mock

提供了三种注解：@MockReturn、@MockBy、@MockByHttp。
其中也对应了三种xml配置MockReturnXmlItem、MockByXmlItem、MockByHttpXmlItem

1. @MockReturn（MockReturnXmlItem）

注解形式：@MockReturn
使用在真实接口上，调用真实接口时，直接使用用户指定的值返回。

/**
 * 含有@MockReturn的方法，将直接返回value
 */
@Target({METHOD})
@Retention(RUNTIME)
public @interface MockReturn {
    /**
     * mock的返回值。复杂对象使用JSON串作为返回值
     * @see MockAspect
     */
    String value();
}

特定值：

String THROW = "THROW()"; // 抛出一个异常
String RANDOM = "RANDOM()"; // 返回一个随机对象
String RANDOM_EXCEPTION = "RANDOM_EXCEPTION()"; // 返回随机对象或抛出一个异常

xml配置形式
具体参考：mock-test/src/main/resources/beans/beans-mock.xml
例：

<bean class="com.kvn.mock.local.config_mock.MockReturnXmlItem"  
	p:mockedMethodFullPath="com.kvn.mock.local.test.ServiceA#method_12()"  
	p:returnValue="123" />

2. @MockBy（MockByXmlItem）

使用在真实接口上，通过第三个类来代理执行真实逻辑，然后返回。 注解形式：@MockBy

/**
 * 含有@MockBy注解的方法，将使用mockMethodFullPath指定的方法的返回值来返回 
 * @author Created by wzy on 2017/6/1.
 */
@Target({ METHOD })
@Retention(RUNTIME)
public @interface MockBy {
	/**
	 * mock方法的全路径。通过它来定位到mock的类和方法
	 * <pre>
	 * 形如：  
	 * mock.com.kvn.service.MockServiceA#mockMethod_4()
	 * mock.com.kvn.service.MockServiceA#mockMethod_11(java.lang.String,com.kvn.domain.Foo)
	 * <b>默认值：</b>
	 * 默认使用的mock类路径为[mock类全路径 = "mock." + 真实类的包名 + ".Mock" + 真实类的类名]，
	 * 默认使用的mock方法名与参数与原方法保持一致
	 * </pre>
	 * @return
	 */
	String delegateMethodFullPath() default MOCKBY_DEFALUT_PATH;
	String MOCKBY_DEFALUT_PATH = "DEFAULT_PATH";
}

xml配置形式
具体参考：mock-test/src/main/resources/beans/beans-mock.xml
例：

<!-- 使用默认的delegateMethodFullPath。 -->  
<bean class="com.kvn.mock.local.config_mock.MockByXmlItem"  
	p:mockedMethodFullPath="com.kvn.service.ServiceA#method_22(java.lang.String,com.kvn.domain.Foo)" />

3. @MockByHttp（MockByHttpXmlItem）

使用第三方Mock服务来代理执行真实逻辑，然后返回mock的结果。为了设计的轻量和对异构系统的支持友好，这里使用了http的方式来调用第三方mock服务。（可以配合mock-server一起使用，也可以自开发mock-server） 注解形式：@MockByHttp

/**
 * 使用http接口来mock，实现mock服务，解耦mock
 */
@Target({ METHOD })
@Retention(RUNTIME)
public @interface MockByHttp {
	/**
	 * http url。默认使用mock/class/method?params=xxx
	 */
	String serverPath() default "";
}

xml配置形式
具体参考：mock-test/src/main/resources/beans/beans-mock.xml
例：

<bean class="com.kvn.mock.local.config_mock.MockByHttpXmlItem"  
					p:mockedMethodFullPath="com.kvn.service.ServiceA#method_17()" />

II. server-mock

接收local-client发送过来的mock请求，并分发到相应的mock请求处理类，进行处理，然后返回mock的执行结果。默认是将local-client的mock请求路由到http://xxx.xxx.xxx:xx/mock/class/method?params=xxx 当然，也可以指定路由地址。 server-mock采用Spring MVC搭建，配合Tomcat一起部署。

构想

后面会增加server-mock返回异常给local-mock
未来可以开发server-mock的配置页面，通过页面来配置mock服务，减少开发量，更加方便

设计

设计图
技术
aop采用Spring AOP
http采用OkHttp

Quick Start

可以参考local-mock里面的test类：MockByTest.java、MockReturnTest.java、MockByHttpTest.java
MockReturn eg:

// 注解形式
@MockReturn("mock_123")
public String method_2() {
	System.out.println("执行真实方法：method_2");
	return "do method_2------[real method methodA_2]";
}

@MockReturn(MockReturn.RANDOM)
public Foo method_9() {
	Foo foo = new Foo();
	foo.setId(1);
	foo.setName("真实Name");
	foo.setNo("真实No");
	System.out.println("执行真实方法：method_9");
	return foo;
}

// 配置形式 （具体参考src/test/resources/beans/beans-mock.xml）
<bean class="com.kvn.mock.local.config_mock.MockReturnXmlItem"
	p:mockedMethodFullPath="com.kvn.mock.local.test.ServiceA#method_12()"
	p:returnValue="RANDOM()" />

MockBy eg:

// 注解形式
@MockBy(delegateMethodFullPath="com.kvn.mock.local.test.MockServiceA#mockMethod_4()")
public String method_4() {
	System.out.println("执行真实方法：method_4");
	return "do method_4------[real method methodA_4]";
}

// 配置形式 （具体参考src/test/resources/beans/beans-mock.xml）
<bean class="com.kvn.mock.local.config_mock.MockByXmlItem"
				p:mockedMethodFullPath="com.kvn.mock.local.test.ServiceA#method_14(java.lang.String,com.kvn.mock.local.test.Foo)"
				p:delegateMethodFullPath="com.kvn.mock.local.test.MockServiceA#mockMethod_14(java.lang.String,com.kvn.mock.local.test.Foo)" />

MockByHttp eg:

// 注解形式
@MockByHttp
public String method_15(){
	System.out.println("执行真实方法：method_15");
	return "do method_15------[real method method_15]";
}

// 配置形式 （具体参考src/test/resources/beans/beans-mock.xml）
<bean class="com.kvn.mock.local.config_mock.MockByHttpXmlItem"
				p:mockedMethodFullPath="com.kvn.mock.local.test.ServiceA#method_17()" />

快鸟 / tiny-mock

Tiny-Mock

简介

特性

I. local-mock

1. @MockReturn（MockReturnXmlItem）

2. @MockBy（MockByXmlItem）

3. @MockByHttp（MockByHttpXmlItem）

II. server-mock

构想

设计

Quick Start

简介

发行版 (4)

贡献者

近期动态

快鸟 / tiny-mock .gitee-modal { width: 500px !important; }

Tiny-Mock

简介

特性

I. local-mock

1. @MockReturn（MockReturnXmlItem）

2. @MockBy（MockByXmlItem）

3. @MockByHttp（MockByHttpXmlItem）

II. server-mock

构想

设计

Quick Start

简介

发行版 (4)

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

快鸟 / tiny-mock