javalicense实现_用Spring构建企业Java应用程序

来源&＃xff1a;SpringForAll社区

通过在本教程中构建一个简单的RESTful web API&＃xff0c;了解关于使用Java EE和Spring框架构建企业Java应用程序的更多信息。

我认为可以说Java EE在Java开发人员中获得了相当坏的名声。尽管多年来&＃xff0c;它确实在各个方面都有所改善&＃xff0c;甚至从Eclipse Foundation变成了JakartaEE&＃xff0c;但它的苦味仍然相当强烈。另一方面&＃xff0c;我们有Spring Framework(或者更好地反映现实&＃xff0c;一个成熟的Spring Platform)&＃xff0c;这是一个出色的、轻量级的、快速的、创新的、高生产力的Java EE替代品。那么&＃xff0c;为什么要为Java EE费心呢?我们将通过展示使用大多数Java EE规范构建现代Java应用程序是多么容易来回答这个问题。在这方面取得成功的关键因素是Eclipse Microprofile:J2EE的微服务时代。我们将要构建的应用程序是用于管理人员的RESTful web API;就这么简单。在Java中构建RESTful web服务的标准方法是使用JAX-RS 2.1 (JSR-370)。因此&＃xff0c;CDI 2.0 (JSR-365)将负责依赖注入&＃xff0c;而JPA 2.0 (JSR-317)将负责数据访问层。当然&＃xff0c;Bean Validation 2.0 (JSR-380)正在帮助我们处理输入验证。我们唯一要依赖的非java EE规范是OpenAPI v3.0&＃xff0c;它有助于提供关于RESTful web api的可用描述。那么&＃xff0c;让我们从personentity域模型开始(省略getter和setter作为不太相关的细节):

&＃64;Entity

&＃64;Table(name &＃61; "people")

public class PersonEntity {

   &＃64;Id &＃64;Column(length &＃61; 256)

   private String email;

   &＃64;Column(nullable &＃61; false, length &＃61; 256, name &＃61; "first_name")

   private String firstName;

   &＃64;Column(nullable &＃61; false, length &＃61; 256, name &＃61; "last_name")

   private String lastName;

   &＃64;Version

   private Long version;

}

它只有一个绝对最小的属性集。JPA存储库非常简单&＃xff0c;实现了一组典型的CRUD方法。

&＃64;ApplicationScoped

&＃64;EntityManagerConfig(qualifier &＃61; PeopleDb.class)

public class PeopleJpaRepository implements PeopleRepository {

   &＃64;Inject &＃64;PeopleDb private EntityManager em;

   &＃64;Override

   &＃64;Transactional(readOnly &＃61; true)

   public Optional findByEmail(String email) {

       final CriteriaBuilder cb &＃61; em.getCriteriaBuilder();

       final CriteriaQuery query &＃61; cb.createQuery(PersonEntity.class);

       final Root root &＃61; query.from(PersonEntity.class);

       query.where(cb.equal(root.get(PersonEntity_.email), email));

       try {

           final PersonEntity entity &＃61; em.createQuery(query).getSingleResult();

           return Optional.of(entity);

       } catch (final NoResultException ex) {

           return Optional.empty();

       }

   }

   &＃64;Override

   &＃64;Transactional

   public PersonEntity saveOrUpdate(String email, String firstName, String lastName) {

       final PersonEntity entity &＃61; new PersonEntity(email, firstName, lastName);

       em.persist(entity);

       return entity;

   }

   &＃64;Override

   &＃64;Transactional(readOnly &＃61; true)

   public Collection findAll() {

       final CriteriaBuilder cb &＃61; em.getCriteriaBuilder();

       final CriteriaQuery query &＃61; cb.createQuery(PersonEntity.class);

       query.from(PersonEntity.class);

       return em.createQuery(query).getResultList();

   }

   &＃64;Override

   &＃64;Transactional

   public Optional deleteByEmail(String email) {

       return findByEmail(email)

           .map(entity -> {

               em.remove(entity);

               return entity;

           });

   }

}

事务管理(即&＃64;Transactionalannotation)需要一些解释。在典型的Java EE应用程序中&＃xff0c;容器运行时负责管理事务。由于我们不想装载应用程序容器&＃xff0c;而是保持精简&＃xff0c;所以我们可以使用EntityManager来启动/提交/回滚事务。这当然是可行的&＃xff0c;但它也会用样板污染代码。可以说&＃xff0c;更好的选择是使用Apache DeltaSpikeCDI扩展用于声明性事务管理(这是&＃64;Transactional和&＃64;EntityManagerConfig注释的来源)。下面的代码片段说明了如何集成它。

&＃64;ApplicationScoped

public class PersistenceConfig {

   &＃64;PersistenceUnit(unitName &＃61; "peopledb")

   private EntityManagerFactory entityManagerFactory;

   &＃64;Produces &＃64;PeopleDb &＃64;TransactionScoped

   public EntityManager create() {

       return this.entityManagerFactory.createEntityManager();

   }

   public void dispose(&＃64;Disposes &＃64;PeopleDb EntityManager entityManager) {

       if (entityManager.isOpen()) {

           entityManager.close();

       }

   }

}

太棒了——最难的部分已经过去了!接下来是person数据传输对象和服务层。

public class Person {

   &＃64;NotNull private String email;

   &＃64;NotNull private String firstName;

   &＃64;NotNull private String lastName;

}

老实说&＃xff0c;为了使示例应用程序尽可能小&＃xff0c;我们可以完全跳过服务层&＃xff0c;直接进入存储库。但总的来说&＃xff0c;这不是一个很好的实践&＃xff0c;所以让我们介绍PeopleServiceImpl。

&＃64;ApplicationScoped

public class PeopleServiceImpl implements PeopleService {

   &＃64;Inject private PeopleRepository repository;

   &＃64;Override

   public Optional findByEmail(String email) {

       return repository

           .findByEmail(email)

           .map(this::toPerson);

   }

   &＃64;Override

   public Person add(Person person) {

       return toPerson(repository.saveOrUpdate(person.getEmail(), person.getFirstName(), person.getLastName()));

   }

   &＃64;Override

   public Collection getAll() {

       return repository

           .findAll()

           .stream()

           .map(this::toPerson)

           .collect(Collectors.toList());

   }

   &＃64;Override

   public Optional remove(String email) {

       return repository

           .deleteByEmail(email)

           .map(this::toPerson);

   }

   private Person toPerson(PersonEntity entity) {

       return new Person(entity.getEmail(), entity.getFirstName(), entity.getLastName());

   }

}

剩下的部分是JAX-RS应用程序和资源的定义。

&＃64;Dependent

&＃64;ApplicationPath("api")

&＃64;OpenAPIDefinition(

   info &＃61; &＃64;Info(

       title &＃61; "People Management Web APIs",

       version &＃61; "1.0.0",

       license &＃61; &＃64;License(

           name &＃61; "Apache License",

           url &＃61; "https://www.apache.org/licenses/LICENSE-2.0"

       )

   )

)

public class PeopleApplication extends Application {

}

没什么好说的;这是尽可能简单的。但是JAX-RS资源实现更有趣(OpenAPI注释占据了大部分位置)。

&＃64;ApplicationScoped

&＃64;Path( "/people" )

&＃64;Tag(name &＃61; "people")

public class PeopleResource {

   &＃64;Inject private PeopleService service;

   &＃64;Produces(MediaType.APPLICATION_JSON)

   &＃64;GET

   &＃64;Operation(

       description &＃61; "List all people",

       responses &＃61; {

           &＃64;ApiResponse(

               content &＃61; &＃64;Content(array &＃61; &＃64;ArraySchema(schema &＃61; &＃64;Schema(implementation &＃61; Person.class))),

               responseCode &＃61; "200"

           )

       }

   )

   public Collection getPeople() {

       return service.getAll();

   }

   &＃64;Produces(MediaType.APPLICATION_JSON)

   &＃64;Path("/{email}")

   &＃64;GET

   &＃64;Operation(

       description &＃61; "Find person by e-mail",

       responses &＃61; {

           &＃64;ApiResponse(

               content &＃61; &＃64;Content(schema &＃61; &＃64;Schema(implementation &＃61; Person.class)),

               responseCode &＃61; "200"

           ),

           &＃64;ApiResponse(

               responseCode &＃61; "404",

               description &＃61; "Person with such e-mail doesn&＃39;t exists"

           )

       }

   )

   public Person findPerson(&＃64;Parameter(description &＃61; "E-Mail address to lookup for", required &＃61; true) &＃64;PathParam("email") final String email) {

       return service

           .findByEmail(email)

           .orElseThrow(() -> new NotFoundException("Person with such e-mail doesn&＃39;t exists"));

   }

   &＃64;Consumes(MediaType.APPLICATION_JSON)

   &＃64;Produces(MediaType.APPLICATION_JSON)

   &＃64;POST

   &＃64;Operation(

       description &＃61; "Create new person",

       requestBody &＃61; &＃64;RequestBody(

           content &＃61; &＃64;Content(schema &＃61; &＃64;Schema(implementation &＃61; Person.class)),

       ),

       responses &＃61; {

           &＃64;ApiResponse(

                content &＃61; &＃64;Content(schema &＃61; &＃64;Schema(implementation &＃61; Person.class)),

                headers &＃61; &＃64;Header(name &＃61; "Location"),

                responseCode &＃61; "201"

           ),

           &＃64;ApiResponse(

               responseCode &＃61; "409",

               description &＃61; "Person with such e-mail already exists"

           )

       }

   )

   public Response addPerson(&＃64;Context final UriInfo uriInfo,

           &＃64;Parameter(description &＃61; "Person", required &＃61; true) &＃64;Valid Person payload) {

       final Person person &＃61; service.add(payload);

       return Response

            .created(uriInfo.getRequestUriBuilder().path(person.getEmail()).build())

            .entity(person)

            .build();

   }

   &＃64;Path("/{email}")

   &＃64;DELETE

   &＃64;Operation(

       description &＃61; "Delete existing person",

       responses &＃61; {

           &＃64;ApiResponse(

               responseCode &＃61; "204",

               description &＃61; "Person has been deleted"

           ),

           &＃64;ApiResponse(

               responseCode &＃61; "404",

               description &＃61; "Person with such e-mail doesn&＃39;t exists"

           )

       }

   )

   public Response deletePerson(&＃64;Parameter(description &＃61; "E-Mail address to lookup for", required &＃61; true ) &＃64;PathParam("email") final String email) {

       return service

           .remove(email)

           .map(r -> Response.noContent().build())

           .orElseThrow(() -> new NotFoundException("Person with such e-mail doesn&＃39;t exists"));

   }

}

这样&＃xff0c;我们就完成了!但是&＃xff0c;我们怎样才能把这些零件组装起来&＃xff0c;然后用电线把它们连在一起呢?现在是 Microprofile进入舞台的时候了。有许多实现可供选择;我们将在这篇文章中使用的是Project Hammock 。我们要做的唯一一件事就是指定我们想要使用的CDI 2.0、JAX-RS 2.1和JPA 2.0实现&＃xff0c;它们分别转换为Weld、Apache CXF和OpenJPA(通过 Project Hammock 依赖关系表示)。让我们来看看Apache Mavenpom.xml文件。

   1.8.1

   2.1

       org.apache.deltaspike.modules

       deltaspike-jpa-module-api

       ${deltaspike.version}

       compile

       org.apache.deltaspike.modules

       deltaspike-jpa-module-impl

       ${deltaspike.version}

       runtime

       ws.ament.hammock

       dist-microprofile

       ${hammock.version}

       ws.ament.hammock

       jpa-openjpa

       ${hammock.version}

       ws.ament.hammock

       util-beanvalidation

       ${hammock.version}

       ws.ament.hammock

       util-flyway

       ${hammock.version}

       ws.ament.hammock

       swagger

       ${hammock.version}

在没有进一步的ado的情况下&＃xff0c;让我们立即构建和运行应用程序(如果您想知道应用程序使用的是什么关系数据存储&＃xff0c;那么它是H2&＃xff0c;在内存中配置了数据库)。

mvn clean package

java -jar target/eclipse-microprofile-hammock-0.0.1-SNAPSHOT-capsule.jar

确保RESTful web api功能完备的最佳方法是向它发送几个请求:

>  curl -X POST http://localhost:10900/api/people -H "Content-Type: applicationjson"

    -d &＃39;{"email": "a&＃64;b.com", "firstName": "John", "lastName": "Smith"}&＃39;

HTTP/1.1 201 Created

Location: http://localhost:10900/api/people/a&＃64;b.com

Content-Type: application/json

{

   "firstName":"John","

   "lastName":"Smith",

   "email":"a&＃64;b.com"

}

如何确保Bean Validation 工作正常?为了触发它&＃xff0c;让我们发送部分准备好的请求。

>  curl  --X POST http://localhost:10900/api/people -H "Content-Type: applicationjson"

    -d &＃39;{"firstName": "John", "lastName": "Smith"}&＃39;

HTTP/1.1 400 Bad Request

Content-Length: 0

OpenAPI规范和预捆绑的Swagger UI发行版也可以通过http://localhost:10900/index.html?url&＃61;http://localhost:10900/api/openapi.json获得。到目前为止&＃xff0c;一切都很好&＃xff0c;但公平地说&＃xff0c;我们根本没有谈到测试我们的应用程序。要为添加一个person的场景设计出集成测试有多难呢?事实证明&＃xff0c;围绕Java EE应用程序测试的框架已经有了很大的改进。特别是&＃xff0c;使用Arquillian测试框架(以及受欢迎的JUnit和REST Assured)非常容易完成。一个真实的例子抵得上千言万语。

&＃64;RunWith(Arquillian.class)

&＃64;EnableRandomWebServerPort

public class PeopleApiTest {

   &＃64;ArquillianResource private URI uri;

   &＃64;Deployment

   public static JavaArchive createArchive() {

       return ShrinkWrap

           .create(JavaArchive.class)

           .addClasses(PeopleResource.class, PeopleApplication.class)

           .addClasses(PeopleServiceImpl.class, PeopleJpaRepository.class, PersistenceConfig.class)

           .addPackages(true, "org.apache.deltaspike");

   }

   &＃64;Test

   public void shouldAddNewPerson() throws Exception {

       final Person person &＃61; new Person("a&＃64;b.com", "John", "Smith");

       given()

           .contentType(ContentType.JSON)

           .body(person)

           .post(uri &＃43; "/api/people")

           .then()

           .assertThat()

           .statusCode(201)

           .body("email", equalTo("a&＃64;b.com"))

           .body("firstName", equalTo("John"))

           .body("lastName", equalTo("Smith"));

   }

}

不神奇吗?实际上&＃xff0c;开发现代Java EE应用程序是非常有趣的&＃xff0c;有人可能会说&＃xff0c;用Spring的方式!事实上&＃xff0c;与Spring的相似之处并非巧合&＃xff0c;因为它很有启发性&＃xff0c;很有启发性&＃xff0c;而且无疑将继续激励Java EE生态系统中的创新。未来如何?我认为&＃xff0c;无论对于雅加达EE还是Eclipse Microprofile来说&＃xff0c;都是光明的。后者刚刚接近2.0版本&＃xff0c;提供了大量新的规范&＃xff0c;这些规范旨在满足微服务体系结构的需求。目睹这些转变真是太棒了。项目的完整源代码可以在GitHub上找到。

原文链接&＃xff1a;https://dzone.com/articles/building-enterprise-java-applications-the-spring-w

作者&＃xff1a;Andriy Redko

译者&＃xff1a;xieed

·END·

 近期热文&＃xff1a;

• 深入聊一聊 Spring AOP 实现机制

• Spring Cloud Stream 学习小清单

• 在一台Mac上不同平台同时使用多个Git账号

• Git 版本控制之 GitFlow

• 彻底搞懂 Git-Rebase

• 我说分布式事务之最大努力通知型事务

• 我说分布式事务之TCC

• 不可错过的CMS学习笔记

• 在生产中使用Java 11&＃xff1a;需要了解的重要事项

• 可能是最全面的G1学习笔记

看完&＃xff0c;赶紧点个“好看”鸭

点鸭点鸭

↓↓↓↓