JHipster创建微服务及相关微服务架构组件介绍
参考链接:
一.创建微服务
微服务是一种JHipster应用程序,它没有前端(必须在网关)上生成Angular前端),并且可以与JHipster Registry一起配置,发现和管理。
创建微服务应用
安装:
- 安装Java 8 from the Oracle website.
- 安装Node.js from the Node.js website (请安装 64-bit version)
- 安装npm包:
npm install -g npm
- 如果你想使用jhipster应用市场, 请安装 Yeoman:
npm install -g yo
- 最后安装JHipster:
npm install -g generator-jhipster
执行jhipster:
//首先要创建一个工程文件夹,然后切换到当前文件夹下
mkdir myapp
cd myapp
//也可以一个命令完成
mkdir myapp && cd myapp
//然后运行
jhipster
生成微服务时的问题:
//选择应用
1.Which *type* of application would you like to create? Microservice gatewayMonolithic application (recommended for simple projects) //单体应用Microservice application // 微服务应用Microservice gateway // 微服务网关// 微服务架构下的用户授权和认证服务JHipster UAA server (for microservice OAuth2 authentication)
//应用的名称,括号里就是当前文件夹的名称,也是推荐的名称
2.What is the base name of your application? gateway
//设置服务的端口号
3.As you are running in a microservice architecture, on which port would like your server to run? It should be unique to avoid port conflicts. 8086
//Java代码都会创建到这个包路径下
4.What is your default Java package name? com.transsion.demo
//选择注册中心。一般选择Registry比较多
5.Which service discovery server do you want to use? JHipster Registry (uses Eureka, provides Spring Cloud Config support and monitoring dashboards)JHipster Registry (uses Eureka)ConsulNo service discovery
//选择什么类型的认证方式,不管用的什么认证方式,服务器端都用Spring Security实现,而不是Apache Shiro。
6.Which *type* of authentication would you like to use? JWT authentication (stateless, with a token)// JWT(JSON Web Token)是一种服务器端无状态(stateless)的认证方式,后两个是有状态的(Stateful)JWT authentication (stateless, with a token) // jwt// Oauth2 OIDC 认证服务OAuth 2.0 / OIDC Authentication (stateful, works with Keycloak and Okta)// Oauth2+jwt Uaa认证服务Authentication with JHipster UAA server (the server must be generated separately)
//选择数据库支持Nosql跟常见RDMB数据库7.Which *type* of database would you like to use? SQL (H2, MySQL, MariaDB, PostgreSQL, Oracle, MSSQL)//用Spring Data JPA实现。pom会自动加上spring-boot-starter-data-jpaSQL (H2, MySQL, MariaDB, PostgreSQL, Oracle, MSSQL)//用Spring Data MongoDB实现。pom会自动加上spring-boot-starter-data-mongodbMongoDB//用Spring Data Couchbase实现。pom会自动加上spring-boot-starter-data-couchbaseCouchbase//用Spring Data for Apache Cassandra实现。pom会自动加上spring-boot-starter-data-cassandraCassandraNo database
//产品环境下用什么数据库,在Spring Boot 的prod profile里配置的数据库
8.Which *production* database would you like to use? MySQLMySQLMariaDBPostgreSQLOracleMicrosoft SQL Server
//开发环境下用什么数据库。也就是在Spring Boot的dev profile里泪痣的数据库
//在开发人员电脑上推荐用H2。MySQL甚至是Oracle只适合安装在测试/产品服务器上
9.Which *development* database would you like to use? MySQL//前两个选项用H2作为开发和自测用数据库H2 with disk-based persistence //测试数据写入硬盘,重启应用或系统都不会丢失H2 with in-memory persistence //测试数据只存在于内存,每次重启应用都没啦MySQL
/*
是否使用Spring缓存,如果使用就选择实现方式。类似JPA和Hiberante/EclipseLink一样,Spring Cache是一个抽象,允许其他厂商提供自己的实现。Ehcache实现支持本地一个节点缓存,Hazelcast实现支持分布式多节点。Monolithic类型的应用选择Ehcache就可以了。
*/
10.Do you want to use the Spring cache abstraction? Yes, with the Hazelcast implementation (distributed cache, for multiple nodes, supports rate-limiting for gateway applications)
/*
之前选择了SQL类型的数据库,所以用到Spring Data JPA,而且默认用到Hibernate的实现。所以这一步需要选择是否用Hibernate的二级缓存。选择Y。
*/
11.Do you want to use Hibernate 2nd level cache? Yes
/*
用Maven还是Gradle作为后端的构建工具。虽然Gradle有很多高级特性和方便之处,但是目前最常用的就还是Maven。我们选择Maven。
*/
12.Would you like to use Maven or Gradle for building the backend? Maven
//是否还用到其他技术。可选的有Elasticsearch、WebSockets、Apache Kafka...
13.Which other technologies would you like to use? Search engine using Elasticsearch
/*
前端用什么框架。Angular和React选其一。现在还没有正式支持vue,而是以Blueprint的方式提供的。
*/
14.Which *Framework* would you like to use for the client? Angular
WARNING! Could not fetch bootswatch themes from API. Using default ones.
15.Would you like to use a Bootswatch theme (https://bootswatch.com/)? Default JHipster
//支持国际化?
16.Would you like to enable internationalization support? Yes
//选择本地支持的语言包含中文
17.Please choose the native language of the application English
//可以额外安装其他语言
18.Please choose additional languages to install (Press to select, to toggle all, to invert selection)
/*
选择测试框架,针对微服务http接口测试,生成测试报告.JHipster默认前端用Jest,服务器端用JUnit作为单元测试框架。
*/
19.Besides JUnit and Jest, which testing frameworks would you like to use? (Press to select, to toggle all, to invert selection)Gatling //性能测试Cucumber //行为测试Protractor //angular集成测试
//从jhipster市场中选择组件安装
20.Would you like to install other generators from the JHipster Marketplace? No
微服务架构中生成实体
如果要实时重载JavaScript/TypeScript代码,则需要运行npm start
或yarn start
。创建应用程序后,将需要创建 实体。例如,您可能要创建一个 Author 和 Book 实体。对于每个实体,您将需要:
如果您有多个实体,则可能需要在它们之间建立关系。为此,您将需要:
“entity”子生成器将创建所有必要的文件,并为每个实体提供一个CRUD前端(请参阅Angular项目结构和React项目结构))。可以通过运行jhipster entity
来调用子生成器。可以通过输入jhipster entity --help
找到这些选项的参考。
使用了JDL Studio:jdl官方语法文档
jhipster import-jdl ./my-jdl-file.jdl --json-only
jhipster import-jdl ./my-jdl-file.jdl --force
如果要使用JHipster UML代替import-jdl
子生成器,则需要先通过运行npm install -g jhipster-uml
来安装它,然后运行jhipster-uml yourFileName.jh
。
字段类型
JHipster支持许多字段类型。这种支持取决于您的数据库后端,因此我们使用Java类型来描述它们:JavaString
将以不同的方式存储在Oracle或Cassandra中,这是JHipster的优势之一,可以为您生成正确的数据库访问代码。
二.JHipster微服务架构概述
“微服务”架构将前端和后端分开,因此您的应用程序可以更轻松地扩展和解决基础架构问题。
JHipster微服务架构以以下方式工作:
在下图中,绿色组件特定于您的应用程序,蓝色组件提供了其基础结构。
三.JHipster API网关
JHipster可以生成API网关。网关是普通的JHipster应用程序,因此您可以在该项目上使用常规的JHipster选项和开发工作流,但它也充当微服务的入口。更具体地说,它为所有微服务提供HTTP路由和负载均衡,服务质量,安全性和API文档。
1.架构图
2.HTTP请求使用网关进行路由
启动网关和微服务后,它们将在registry中注册自己(使用src/main/resources/config/application.yml
文件中的eureka.client.serviceUrl.defaultZone
项)。
网关将使用其应用程序名字自动将所有请求代理到微服务:例如,注册微服务app1
时,该请求在网关上的/app1
URL上可用。
例如,如果您的网关运行在localhost:8080
上,则可以指向http://localhost:8080/app1/rest/foos来获取微服务app1
服务的foos资源。 如果您尝试使用Web浏览器执行此操作,请不要忘记REST资源在JHipster中是默认保护的,因此您需要发送正确的JWT标头(请参见下面的安全性要点),或在微服务的MicroserviceSecurityConfiguration
类删除这些URL安全保护。
3.JWT(JSON Web令牌)
JWT(JSON Web令牌)是一种行业标准、易于使用的方法,用于保护微服务体系结构中的应用程序。JHipster使用Okta提供的JJWT library来实现JWT。令牌由网关生成,并发送到底层微服务:由于它们共享一个公共密钥,因此微服务能够验证令牌并使用该令牌对用户进行身份验证。
这些令牌是自我描述的:它们具有身份验证和授权信息,因此微服务不需要查询数据库或外部系统。这对于确保可扩展的体系结构很重要。
4.JHipster UAA
JHipster提供了基于Spring Security生成 “UAA”(用户帐户和身份验证)服务器的选项。该服务器提供OAuth2令牌以保护网关。
网关使用Spring Security的JWT实现将JWT令牌发送到微服务,因此,其工作原理与上述JWT配置基本相同。
5.自动文档
网关暴露了它所代理服务的Swagger API,许多工具依赖此特性,例如Swagger UI和swagger-codegen。
网关的”admin > API”菜单具有特定的下拉列表,其中显示了网关的API以及已注册的微服务中的所有暴露API。
6.限速
网关提供速率限制功能,因此可以限制REST请求的数量:
然后,JHipster将使用Bucket4j和Hazelcast请求计数,并在超出限制时发送HTTP 429(请求过多)错误。每个用户的默认限制是每小时100,000个API调用。
网关在保护REST端点安全时,可以完全访问用户的安全信息,因此可以轻松地扩展它,以根据用户的安全角色提供特定的速率限制。
要启用速率限制,请打开application-dev.yml
或application-prod.yml
文件,并将enabled
设置为true
:
jhipster:gateway:rate-limiting:enabled: true
数据存储在Hazelcast中,因此,只要配置了Hazelcast分布式缓存,便可以扩展网关,该网关可以直接使用:
如果要添加更多规则或修改现有规则,则需要在RateLimitingFilter
类中对其进行编码。修改示例可能是:
7.访问控制策略
默认情况下,所有已注册的微服务都可以通过网关来访问。如果要排除通过网关公开访问的特定API,可以使用网关的特定访问控制策略过滤器。可以使用application-*.yml
文件中的jhipster.gateway.authorized-microservices-endpoints
密钥对其进行配置:
jhipster:gateway:authorized-microservices-endpoints: # Access Control Policy, if left empty for a route, all endpoints will be accessibleapp1: /api,/v2/api-docs # recommended dev configuration
例如,如果您只希望微服务bar
的 /api/foo
API端点可用:
jhipster:gateway:authorized-microservices-endpoints:bar: /api/foo
四.Traefik
Traefik是现代的HTTP反向代理和负载均衡器,旨在轻松部署微服务。它可以像Zuul一样路由HTTP请求,因此它与JHipster网关有些功能重叠,但是它工作在API网关更低的层面:它仅路由HTTP请求,不提供速率限制,安全性或Swagger文档聚合。
Traefik的好处之一是可以与许多不同的服务发现解决方案一起使用:但是,对于JHipster,默认情况下,它仅与 Consul一起使用。它可以应用于两种不同的体系结构样式,如下所述。
架构图1: 默认配置
由于Traefik是反向代理和负载均衡器,因此它取代了Zuul,并将所有HTTP请求直接路由到正确的服务。
在这种架构中,JHipster“网关”不再是真正的网关,它主要是在这里为Angular应用程序服务。这是默认配置.
架构图2: Traefik和Zuul
Traefik也可以与Zuul一起使用:在这种情况下,对微服务的HTTP请求,先通过Traefik,然后通过Zuul,然后再到达其目的地。
这道中了更多的网络请求,因此效率不如以前的体系结构。但是,这允许充分利用JHipster网关:它可以专心处理速率限制或Swagger文档聚合。
总之,Traefik可以用作边缘服务,从而可以方便扩展JHipster网关。
此配置可与JHipster一起使用,开箱即用:唯一的问题是客户端应用程序使用绝对URL,例如对于”microservice1”:
入门
Traefik仅适用于Consul,因此,如果您使用 JHipster Registry,则此功能将无效。
在微服务架构中使用Traefik,请运行docker-compose子生成器,并在出现询问您要使用哪个网关的问题时选择Traefik。
这将生成一个用于在Docker中运行Traefik的traefik.yml
配置以及一个traefik/traefik.toml
文件,该文件是Traefik的配置文件。
设置此配置文件是为了:
由于Traefik使用Consul,因此检查Consul管理UI也很有用,该UI可在端口8500
上找到:http://localhost:8500。
五.JHipster Registry
JHipster Registry是JHipster团队提供的应用程序。与JHipster生成器一样,它是一个开源,Apache 2-licensed应用程序,其源代码在JHipster组织的GitHub上可用:jhipster/jhipster-registry
JHipster Registry具有三个主要功能:
所有这些功能都通过基于Angular的现代用户界面,打包到一个便利的应用程序中。
使用预打包的WAR文件安装
JHipster Registry在我们的发行页面页面上提供了可执行的WAR文件。
下载WAR文件,并使用您要使用的配置文件(通常是JHipster应用程序)运行它(请参阅关于配置文件的上一节)。例如,要使用存储在central-config
目录中的Spring Cloud Config配置运行它:
./jhipster-registry-.jar --spring.security.user.password=admin --jhipster.security.authentication.jwt.secret=my-secret-key-which-should-be-changed-in-production-and-be-base64-encoded --spring.cloud.config.server.composite.0.type=native --spring.cloud.config.server.composite.0.search-locations=file:./central-config// demo
java -jar jhipster-registry-6.1.1.jar --spring.security.user.password=admin --jhipster.security.authentication.jwt.secret=ZjczYmZkMzRlZWQ5NjJjNDNhNTlhNzg0ZTQwOTAzMWFmN2RhOTlhYmY0OGVlOGVmZjhlYWU0NTdhOGZlNGNhODFjZWJhYmU4NjIyYzhlNWFlNTE3N2RkOWM2OTMyZWZiNDQ3ZGM3ZjU0ZGFmZGU2NjcyMDU3MmE1YmFmNDVjZTk= --spring.cloud.config.server.composite.0.type=native --spring.cloud.config.server.composite.0.search-locations=file:./central-config
请注意,通过使用JHIPSTER_SECURITY_AUTHENTICATION_JWT_SECRET
环境变量或使用如上所述的参数,向启动时的registry提供JWT密钥很重要。另一种可能的方法是在集中式配置源的application.yml
文件中设置此值(该文件在启动时由所有应用程序(包括registry)加载)。
请注意,自JHipster 5.3.0起,我们有了一个新的jhipster.security.authentication.jwt.base64-secret
属性,该属性更安全,但是由于您可能仍使用旧版本,因此我们也使用jhipster.security.authentication.jwt.secret
属性。有关这些属性的更多信息,请参考我们的安全性文档。
同样,要使用prod
配置文件运行registry,请根据您的设置调整参数,例如:
./jhipster-registry-.jar --spring.profiles.active=prod --spring.security.user.password=admin --jhipster.security.authentication.jwt.secret=my-secret-key-which-should-be-changed-in-production-and-be-base64-encoded --spring.cloud.config.server.composite.0.type=git --spring.cloud.config.server.composite.0.uri=https://github.com/jhipster/jhipster-registry-sample-config./jhipster-registry-.jar --spring.profiles.active=prod --spring.security.user.password=admin --jhipster.security.authentication.jwt.secret=my-secret-key-which-should-be-changed-in-production-and-be-base64-encoded --spring.cloud.config.server.composite.0.type=git --spring.cloud.config.server.composite.0.uri=https://github.com/jhipster/jhipster-registry --spring.cloud.config.server.composite.0.search-paths=central-config
从源码构造安装
可以直接从jhipster/jhipster-registry克隆/fork/下载JHipster Registry。由于JHipster Registry也是JHipster生成的应用程序,因此您可以像其他任何JHipster应用程序一样运行它:
请注意,要使用dev
和composite
配置文件,您需要在配置中包含一个central-config
目录,因此,如果运行./jhipster-registry-
,您将需要建立该目录。
标签:
相关文章
-
无相关信息