Since the service-interfaces are registered onto zoo-keeper, we can now try to consume them.
Step 6 Prepare the consumer-project
- Create the folder-structure for the consumer-project.
e:\Downloads\documents\STS_projects\justProject>cd consumer
e:\Downloads\documents\STS_projects\justProject\consumer>mkdir src\main\java\mconsumer
e:\Downloads\documents\STS_projects\justProject\consumer>tree . /f
卷 Tools 的文件夹 PATH 列表
卷序列号为 E885-5830
E:\DOWNLOADS\DOCUMENTS\STS_PROJECTS\JUSTPROJECT\CONSUMER
└─src
└─main
└─java
└─mconsumer
- Create
pom.xml
for consumer-project, it also depends on the library-project.
Content of
consumer\pom.xml
4.0.0
com.justproject.example
consumer
jar
1.0-SNAPSHOT
com.justproject.example
parentproject
1.0-SNAPSHOT
com.justproject.example
common_api
1.0-SNAPSHOT
org.springframework.boot
spring-boot-maven-plugin
- Add the module definition in parent-project.
pom.xml
of parent-project
4.0.0
com.justproject.example
parentproject
pom
1.0-SNAPSHOT
org.springframework.boot
spring-boot-starter-parent
1.5.7.RELEASE
org.springframework
spring-context
org.springframework.boot
spring-boot-autoconfigure
common_api
consumer
provider
- Add an entry-point for the consumer-project.
Content of
consumer\src\main\java\mconsumer\Consumer.java
package mconsumer;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Consumer {
public static void main(String[] args) {
SpringApplication.run(Consumer.class, args);
}
}
- Try to package this empty project.
e:\Downloads\documents\STS_projects\justProject\consumer>tree . /f
卷 Tools 的文件夹 PATH 列表
卷序列号为 E885-5830
E:\DOWNLOADS\DOCUMENTS\STS_PROJECTS\JUSTPROJECT\CONSUMER
│ .classpath
│ .project
│ pom.xml
│
├─.settings
│ org.eclipse.core.resources.prefs
│ org.eclipse.jdt.core.prefs
│ org.eclipse.wst.common.project.facet.core.xml
│
└─src
└─main
└─java
└─mconsumer
Consumer.java
e:\Downloads\documents\STS_projects\justProject\consumer>mvn clean package
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------< com.justproject.example:consumer >------------------
[INFO] Building consumer 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.6.1:clean (default-clean) @ consumer ---
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ consumer ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory e:\Downloads\documents\STS_projects\justProject\consumer\src\main\resources
[INFO] skip non existing resourceDirectory e:\Downloads\documents\STS_projects\justProject\consumer\src\main\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ consumer ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 1 source file to e:\Downloads\documents\STS_projects\justProject\consumer\target\classes
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ consumer ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory e:\Downloads\documents\STS_projects\justProject\consumer\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ consumer ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-surefire-plugin:2.18.1:test (default-test) @ consumer ---
[INFO] No tests to run.
[INFO]
[INFO] --- maven-jar-plugin:2.6:jar (default-jar) @ consumer ---
[INFO] Building jar: e:\Downloads\documents\STS_projects\justProject\consumer\target\consumer-1.0-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:1.5.7.RELEASE:repackage (default) @ consumer ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 5.170 s
[INFO] Finished at: 2018-08-01T14:07:58+08:00
[INFO] ------------------------------------------------------------------------
e:\Downloads\documents\STS_projects\justProject\consumer>
Step 7 Add a controller for the consumer-project
- To use annotation @RestController, add dependency in
pom.xml
of the consumer-project.
Content of
consumer\pom.xml
4.0.0
com.justproject.example
consumer
jar
1.0-SNAPSHOT
com.justproject.example
parentproject
1.0-SNAPSHOT
com.justproject.example
common_api
1.0-SNAPSHOT
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-maven-plugin
- Write a controller to handle the request.
Content of
consumer\src\main\java\mconsumer\SampleController.java
package mconsumer;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class SampleController {
@RequestMapping("/test")
public String test() {
return "hello from test.";
}
}
- Create the
resources
folder for the consumer-project.
e:\Downloads\documents\STS_projects\justProject\consumer>mkdir src\main\resources
e:\Downloads\documents\STS_projects\justProject\consumer>mvn clean
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------< com.justproject.example:consumer >------------------
[INFO] Building consumer 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.6.1:clean (default-clean) @ consumer ---
[INFO] Deleting e:\Downloads\documents\STS_projects\justProject\consumer\target
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.098 s
[INFO] Finished at: 2018-08-01T14:18:29+08:00
[INFO] ------------------------------------------------------------------------
e:\Downloads\documents\STS_projects\justProject\consumer>tree .
卷 Tools 的文件夹 PATH 列表
卷序列号为 E885-5830
E:\DOWNLOADS\DOCUMENTS\STS_PROJECTS\JUSTPROJECT\CONSUMER
├─.settings
└─src
└─main
├─java
│ └─mconsumer
└─resources
- Create the
application.properties
file to save the configuration for consumer-project
Content of
consumer\src\main\resources\application.properties
## Use a different port
server.port=6666
- Package and run the consumer-project to see.
e:\Downloads\documents\STS_projects\justProject\consumer>mvn clean package
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------< com.justproject.example:consumer >------------------
[INFO] Building consumer 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.6.1:clean (default-clean) @ consumer ---
[INFO] Deleting e:\Downloads\documents\STS_projects\justProject\consumer\target
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ consumer ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO] Copying 0 resource
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ consumer ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 2 source files to e:\Downloads\documents\STS_projects\justProject\consumer\target\classes
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ consumer ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory e:\Downloads\documents\STS_projects\justProject\consumer\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ consumer ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-surefire-plugin:2.18.1:test (default-test) @ consumer ---
[INFO] No tests to run.
[INFO]
[INFO] --- maven-jar-plugin:2.6:jar (default-jar) @ consumer ---
[INFO] Building jar: e:\Downloads\documents\STS_projects\justProject\consumer\target\consumer-1.0-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:1.5.7.RELEASE:repackage (default) @ consumer ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 5.545 s
[INFO] Finished at: 2018-08-01T14:23:42+08:00
[INFO] ------------------------------------------------------------------------
e:\Downloads\documents\STS_projects\justProject\consumer>java -jar target\consumer-1.0-SNAPSHOT.jar
- Access
http://localhost:666/test
or usecurl
to see that the consumer is working.
C:\Users\home>curl http://localhost:6666/test
hello from test.
Step 8 Change consumer-project to consume from zoo-keeper
- Add dependency to dubbo & zoo-keeper
Content of
consumer\pom.xml
4.0.0
com.justproject.example
consumer
jar
1.0-SNAPSHOT
com.justproject.example
parentproject
1.0-SNAPSHOT
com.justproject.example
common_api
1.0-SNAPSHOT
org.springframework.boot
spring-boot-starter-web
io.dubbo.springboot
spring-boot-starter-dubbo
1.0.0
org.apache.zookeeper
zookeeper
3.4.6
org.slf4j
slf4j-log4j12
log4j
log4j
org.springframework.boot
spring-boot-maven-plugin
- Add a service-class, which refers to the service-interface.
Content of
consumer\src\main\java\mconsumer\AnotherServiceConsumer.java
package mconsumer;
import org.springframework.stereotype.Component;
import com.alibaba.dubbo.config.annotation.Reference;
import mapi.IAnotherService;
@Component
public class AnotherServiceConsumer {
@Reference
IAnotherService anotherService;
public String printSomething() {
return anotherService.sayHello();
}
}
- Update the controller to use the service-class.
Content of
consumer\src\main\java\mconsumer\SampleController.java
package mconsumer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class SampleController {
@Autowired
AnotherServiceConsumer consumer;
@RequestMapping("/test")
public String test() {
return consumer.printSomething();
}
}
- Edit
application.properties
, to use zoo-keeper.
Here, we should define to scan the package of the service-implementation, not the package where we define the service-interface!!!
Content of
consumer\src\main\resources\application.properties
## Use a different port
server.port=6666
## Configuration as a dubbo-consumer
spring.dubbo.application.name=provider
spring.dubbo.registry.address=zookeeper://xxx.xxx.xxx.xxx:2181
## package to scan for the service
spring.dubbo.scan=mconsumer
- Package the consumer-project & run it.
e:\Downloads\documents\STS_projects\justProject\consumer>mvn clean package
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------< com.justproject.example:consumer >------------------
[INFO] Building consumer 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.6.1:clean (default-clean) @ consumer ---
[INFO] Deleting e:\Downloads\documents\STS_projects\justProject\consumer\target
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ consumer ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO] Copying 0 resource
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ consumer ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 3 source files to e:\Downloads\documents\STS_projects\justProject\consumer\target\classes
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ consumer ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory e:\Downloads\documents\STS_projects\justProject\consumer\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ consumer ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-surefire-plugin:2.18.1:test (default-test) @ consumer ---
[INFO] No tests to run.
[INFO]
[INFO] --- maven-jar-plugin:2.6:jar (default-jar) @ consumer ---
[INFO] Building jar: e:\Downloads\documents\STS_projects\justProject\consumer\target\consumer-1.0-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:1.5.7.RELEASE:repackage (default) @ consumer ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 6.022 s
[INFO] Finished at: 2018-08-01T16:31:42+08:00
[INFO] ------------------------------------------------------------------------
e:\Downloads\documents\STS_projects\justProject\consumer>java -jar target\consumer-1.0-SNAPSHOT.jar
- Access
http://localhost:666/test
or usecurl
to see that the consumer is working.
C:\Users\home>curl http://localhost:6666/test
Hello from AnotherServiceImp
More
We can configure to ask Spring to scan multiple-packages, in case we defined different services in the practice. Example of application.properties
as below.
## Configuration as a dubbo-provider
spring.dubbo.application.name=provider
spring.dubbo.registry.address=zookeeper://aaa.bbb.ccc.ddd:2181
spring.dubbo.protocol.name=dubbo
spring.dubbo.protocol.port=20880
## package to scan for the service
spring.dubbo.scan=mservice,moreservice
References
- Blog post that resolved the key-point
- Blog post explains spring.dubbo.scan