簡単なスタート:Spring + MongoDB





ハブで同様の記事を見た。



アプリケーション自体はどうなりますか:
例を使用して基本的なCRUD操作を試すために、最も単純な連絡先マネージャーを作成しましょう。



使用されているライブラリ:


プロジェクトはMavenによって構築され、コードは個人的にIntellij IDEAで作成します(これはJavaに最適なIDEだと思います)。 ところで、 asolntsevはかつてIDEAがEclipseより優れている理由についての記事でこの環境の利点について語っていました。



プロジェクト構成


最初に、Maven構成について説明しましょう。



pom.xml
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <packaging>war</packaging> <groupId>habra</groupId> <artifactId>habr</artifactId> <version>1.0-SNAPSHOT</version> <!--    ,     --> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <version.jdk>1.6</version.jdk> <version.spring>4.0.2.RELEASE</version.spring> <version.spring.mongodb>1.4.0.RELEASE</version.spring.mongodb> <version.jackson>1.9.13</version.jackson> </properties> <dependencies> <!-- ,    Spring --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>${version.spring}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>${version.spring}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>${version.spring}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>${version.spring}</version> </dependency> <dependency> <groupId>org.springframework.data</groupId> <artifactId>spring-data-mongodb</artifactId> <version>${version.spring.mongodb}</version> </dependency> <!-- MongoDB  --> <dependency> <groupId>org.mongodb</groupId> <artifactId>mongo-java-driver</artifactId> <version>2.11.4</version> </dependency> <!-- Jackson JSON Mapper   ,    API   JSON .        . --> <dependency> <groupId>org.codehaus.jackson</groupId> <artifactId>jackson-mapper-asl</artifactId> <version>${version.jackson}</version> </dependency> <!-- Servlet Api --> <dependency> <groupId>javax.servlet</groupId> <artifactId>servlet-api</artifactId> <version>2.5</version> <scope>provided</scope> </dependency> <dependency> <groupId>javax.servlet.jsp</groupId> <artifactId>jsp-api</artifactId> <version>2.1</version> <scope>provided</scope> </dependency> <dependency> <groupId>jstl</groupId> <artifactId>jstl</artifactId> <version>1.2</version> </dependency> <!--  --> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.5</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>1.7.5</version> </dependency> <!-- TEST --> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.11</version> <scope>test</scope> </dependency> <!-- Apache Commons,       -  .    . --> <dependency> <groupId>commons-io</groupId> <artifactId>commons-io</artifactId> <version>2.4</version> </dependency> <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> <version>2.6</version> </dependency> <dependency> <groupId>commons-fileupload</groupId> <artifactId>commons-fileupload</artifactId> <version>1.3.1</version> </dependency> </dependencies> <build> <plugins> <plugin> <artifactId>maven-war-plugin</artifactId> <version>2.4</version> <configuration> <webXml>src/main/webapp/WEB-INF/web.xml</webXml> </configuration> </plugin> </plugins> </build> </project>
      
      





すべてのライブラリが説明されたので、Spring構成ファイルの説明を開始できます。

これを行うには、通常src / main / resourcesにspringフォルダーを作成し、webapp / WEB-INF / *にSpring構成ファイルを保存しますが、これは既に誰にとっても便利です。 構成ファイルは2つあるとすぐに言いますが、少なくともこれが構成記述の最も正しいバージョンだと思います。 最初のファイルには、Beanの作成、データベースへの接続など、アプリケーション全体のコンテキスト設定が含まれます。 2番目のファイルは、DispatcherServletの作業の説明です。一般的には、ページの表示に関連するすべてのもの、および一般にSpring MVCに関連します。



アプリケーション全体のコンテキストを説明することから始めましょう。



src / main / resources / spring / applicationContext.xml
 <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:mongo="http://www.springframework.org/schema/data/mongo" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/data/mongo http://www.springframework.org/schema/data/mongo/spring-mongo.xsd"> <!--     @Service, @Controller, @Repository... --> <context:annotation-config/> <!--  Spring ,      ,   @Service, @Repository,    ,     @Controller, ..        . --> <context:component-scan base-package="ru.habrahabr.sm"> <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/> </context:component-scan> <!--  properties    Spring (.. ).        ${mongo.host} ( . ) --> <context:property-placeholder location="classpath:database.properties"/> <!--   'mongo' --> <mongo:mongo host="${mongo.host}" port="${mongo.port}"/> <!--   'mongoDbFactory'.  MongoDB   ,   username, password   --> <mongo:db-factory username="${mongo.username}" password="${mongo.password}" dbname="${mongo.db}" mongo-ref="mongo"/> <bean id="mongoTemplate" class="org.springframework.data.mongodb.core.MongoTemplate"> <constructor-arg name="mongoDbFactory" ref="mongoDbFactory"/> </bean> </beans>
      
      





Spring MVCコンテキストの説明:



src / main / resources / spring / dispatcherServlet.xml
 <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:mvc="http://www.springframework.org/schema/mvc" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd"> <!--  MVC  --> <mvc:annotation-driven/> <!--  MVC Resources  ,     webapp/resources/    : localhost/resources/ --> <mvc:resources mapping="/resources/**" location="/resources/"/> <!--  Spring MVC   - --> <context:component-scan base-package="ru.habrahabr.sm"> <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller" /> </context:component-scan> <!--  Spring MVC     View,     "/WEB-INF/pages/" --> <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/pages/"/> <property name="suffix" value=".jsp"/> </bean> </beans>
      
      





素晴らしい、Springは構成されていますが、構成ファイルを注意深く読んだ場合、 applicationContext.xmlで「 classpath:database.properties 」をプルしたことに気付くでしょう。 これは、次の内容の「database.properties」ファイルを作成する必要があることを意味します。



src / main / resources / database.properties
 mongo.host=localhost mongo.port=27017 mongo.db=mydb mongo.username=username mongo.password=password
      
      





もちろん、「=」記号の後のデータを独自のものに置き換える必要があります。 ユーザー名とパスワードのフィールドはオプションであり、MongoDBにアクセスするための承認が必要ない場合は、applicationContext.xmlを見てください。これは、どのフィールドを削除する必要があるかを示しています。

ロギングシステムの構成ファイルをすぐに作成します。



src / main / resources / log4j.properties
 log4j.rootLogger=INFO, stdout # Direct log messages to stdout log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.target=System.out log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.conversionPattern=%d{dd.MM.yy HH:mm:ss} %5p - %m%n log4j.appender.stdout.encoding=UTF-8
      
      





最後に、Java Webアプリケーションの構成の最終段階であるweb.xmlの説明に進むことができます。



src / main / webapp / WEB-INF / web.xml
 <web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> <!-- Spring Application Context --> <context-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring/applicationContext.xml</param-value> </context-param> <listener> <listener-class> org.springframework.web.context.ContextLoaderListener </listener-class> </listener> <!-- /Spring Application Context --> <!-- Spring Dispatcher Servlet Context --> <servlet> <servlet-name>dispatcher</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring/dispatcherServlet.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>dispatcher</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> <!-- /Spring Dispatcher Servlet Context --> <!-- Filters --> <!-- Character Filter --> <filter> <filter-name>encodingFilter</filter-name> <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> <init-param> <param-name>encoding</param-name> <param-value>UTF-8</param-value> </init-param> <init-param> <param-name>forceEncoding</param-name> <param-value>true</param-value> </init-param> </filter> <filter-mapping> <filter-name>encodingFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <!-- /Character Filter --> <!-- /Filters --> </web-app>
      
      





この段階では、プロジェクトに次のファイル構造が既にあるはずです。



静的コンテンツ(画像、スタイル、jsスクリプトなど)を「src / webapp / resources /」フォルダーに入れることができます。



コード記述
最後に、プロジェクトが構成され、アプリケーションコード自体の記述を開始できます。 まず、モデルの説明とデータベース層の実装から始めましょう。 次のことに注意してください。MongoDBには整数のAUTO_INCREMENT PKフィールドがなく、オブジェクトにはデフォルトで次のIDが割り当てられます:ObjectId( "5326b46f44ae9e6328b4566c")。 Spring DataはこのIDをString型のオブジェクトとして理解します。 簡単に言えば、オブジェクトIDを整数にして自動増加させる必要がある場合は、自分で作業する必要があります。 しかし、実際には、これには複雑なことはなく、それを恐れる必要はありませんが、これがどのように行われるかを説明します! オブジェクトIDとして長い文字列に満足したら、「シーケンス」という単語が発生するすべてのクラス(およびそれに応じた使用)をスキップします。



最初に、sequencesという名前のコレクションをデータベースに作成します。 そして、手でオブジェクトをそこに挿入します(挿入):
 { "_id" : "contacts", "sequence" : 0 }
      
      



このコレクションでは、「テーブル名」-「最後のID」のペアを保存します。これは、自己記述のAUTO_INCREMENT実装を使用する各テーブル(コレクション)について、上記のように、新しいレコードを作成するだけでよいことを意味します「連絡先」の代わりに、必要なコレクションの名前を入力します。 ところで、MongoDBに使用するツール(管理ツール)がまだわからない場合は、 Robomongoをお勧めします



次に、このコレクションのラッパークラスを作成します。



Sequence.java
 package ru.habrahabr.sm.model; import org.springframework.data.annotation.Id; import org.springframework.data.mongodb.core.mapping.Document; /** * Date: 26.03.2014 * Time: 15:38 * * @author Ruslan Molchanov (ruslanys@gmail.com) */ @Document(collection = Sequence.COLLECTION_NAME) public class Sequence { public static final String COLLECTION_NAME = "sequences"; @Id private String id; private Long sequence; public Sequence() { } public String getId() { return id; } public void setId(String id) { this.id = id; } public Long getSequence() { return sequence; } public void setSequence(Long sequence) { this.sequence = sequence; } }
      
      





エントリ "@Doc​​ument(collection = Sequence.COLLECTION_NAME)"に注意してください。実際には "@Doc​​ument(collection =" sequence ")"と書くことができますが、これはむしろ好みの問題です。 さらに、この方法には明らかな利点が1つあり、どちらを使用するかを理解できます。



ここで、「 Sequence 」ラッパークラスのデータベースレイヤーについて説明します。記事を拡大しないように、サービスとDAOのインターフェイスを作成せず、オブジェクト実装を既に使用します(これはあまり良くないようですが)。危機にwhatしているものを理解します。



SequenceDao.java
 package ru.habrahabr.sm.dao; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.mongodb.core.FindAndModifyOptions; import org.springframework.data.mongodb.core.MongoOperations; import org.springframework.data.mongodb.core.query.Criteria; import org.springframework.data.mongodb.core.query.Query; import org.springframework.data.mongodb.core.query.Update; import org.springframework.stereotype.Repository; import ru.habrahabr.sm.exceptions.SequenceException; import ru.habrahabr.sm.model.Sequence; /** *      www.mkyong.com * http://mkyong.com/mongodb/spring-data-mongodb-auto-sequence-id-example/ */ @Repository public class SequenceDao { @Autowired private MongoOperations mongoOperations; public Long getNextSequenceId(String key) { //   Sequence    Query query = new Query(Criteria.where("id").is(key)); //   sequence   Update update = new Update(); update.inc("sequence", 1); //  ,      FindAndModifyOptions options = new FindAndModifyOptions(); options.returnNew(true); //   :) Sequence sequence = mongoOperations.findAndModify(query, update, options, Sequence.class); // if no sequence throws SequenceException if(sequence == null) throw new SequenceException("Unable to get sequence for key: " + key); return sequence.getSequence(); } }
      
      





これで、 `sequences`のコレクションに、対応するエントリがデータベースにない場合にスローされる例外クラス(上で書きました):



SequenceException.java
 package ru.habrahabr.sm.exceptions; /** * Date: 26.03.2014 * Time: 16:09 * * @author Ruslan Molchanov (ruslanys@gmail.com) */ public class SequenceException extends RuntimeException { public SequenceException(String message) { super(message); } }
      
      





次に、データベースに「contacts」コレクションとラッパークラスを作成します。



Contact.java
 package ru.habrahabr.sm.model; import org.springframework.data.annotation.Id; import org.springframework.data.mongodb.core.mapping.Document; import java.io.Serializable; /** * Date: 26.03.2014 * Time: 15:29 * * @author Ruslan Molchanov (ruslanys@gmail.com) */ @Document(collection = Contact.COLLECTION_NAME) public class Contact implements Serializable { public static final String COLLECTION_NAME = "contacts"; @Id private Long id; /* *******************************************************   ,  ID     (     ),    ID : @Id private String id; ********************************************************* */ private String name; private String number; private String email; public Contact() { } public Contact(String name, String number, String email) { this.name = name; this.number = number; this.email = email; } public Long getId() { return id; } public void setId(Long id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getNumber() { return number; } public void setNumber(String number) { this.number = number; } public String getEmail() { return email; } public void setEmail(String email) { this.email = email; } }
      
      





次に、ContactクラスのDAOレイヤーについて説明します。



ContactDao.java
 package ru.habrahabr.sm.dao; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.mongodb.core.MongoOperations; import org.springframework.data.mongodb.core.query.Criteria; import org.springframework.data.mongodb.core.query.Query; import org.springframework.stereotype.Repository; import ru.habrahabr.sm.model.Contact; import java.util.List; /** * Date: 26.03.2014 * Time: 19:13 * * @author Ruslan Molchanov (ruslanys@gmail.com) */ @Repository public class ContactDao { @Autowired private MongoOperations mongoOperations; public void save(Contact contact) { mongoOperations.save(contact); } public Contact get(Long id) { return mongoOperations.findOne(Query.query(Criteria.where("id").is(id)), Contact.class); } public List<Contact> getAll() { return mongoOperations.findAll(Contact.class); } public void remove(Long id) { mongoOperations.remove(Query.query(Criteria.where("id").is(id)), Contact.class); } }
      
      





次のように、DAOレベルでデータベースレコードを更新できることに注意してください。
 mongoOperations.updateFirst(query, update, Contact.class);
      
      



あなた自身でこれに対処することはこれまで以上に簡単であり、あなたにとって難しいことではありません。 しかし、あなたがそうするならば、私は注意したいと思います:
 mongoOperations.save(contact);
      
      



IDを持つオブジェクトが既に設定され、データベースに存在する場合、オブジェクトは指定されたIDのデータベースで上書きされます。



次に、Contactクラスのビジネスロジックレイヤーについて説明します。



ContactService.java
 package ru.habrahabr.sm.services; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import ru.habrahabr.sm.dao.ContactDao; import ru.habrahabr.sm.dao.SequenceDao; import ru.habrahabr.sm.model.Contact; import java.util.List; /** * Date: 26.03.2014 * Time: 20:09 * * @author Ruslan Molchanov (ruslanys@gmail.com) */ @Service public class ContactService { @Autowired private SequenceDao sequenceDao; @Autowired private ContactDao contactDao; public void add(Contact contact) { contact.setId(sequenceDao.getNextSequenceId(Contact.COLLECTION_NAME)); contactDao.save(contact); } public void update(Contact contact) { contactDao.save(contact); } public Contact get(Long id) { return contactDao.get(id); } public List<Contact> getAll() { return contactDao.getAll(); } public void remove(Long id) { contactDao.remove(id); } }
      
      





さて、これですべてです。Spring+ MongoDBに関するすべてを行いました。 これで、プロジェクトに既に接続されているMongoDBでORM Spring Dataを使用できますが、データベースの操作をディレクトリの例として示すと約束したので、別のコントローラークラスを記述する必要があります。



MainController.java
 package ru.habrahabr.sm.web; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.ModelAttribute; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.servlet.ModelAndView; import ru.habrahabr.sm.model.Contact; import ru.habrahabr.sm.services.ContactService; /** * Date: 26.03.2014 * Time: 20:30 * * @author Ruslan Molchanov (ruslanys@gmail.com) */ @Controller public class MainController { @Autowired private ContactService contactService; @RequestMapping(value = "/", method = RequestMethod.GET) public ModelAndView showAll() { ModelAndView modelAndView = new ModelAndView("all"); modelAndView.addObject("contacts", contactService.getAll()); return modelAndView; } @RequestMapping(value = "/add", method = RequestMethod.GET) public ModelAndView showAddForm() { return new ModelAndView("add_form", "contact", new Contact()); } @RequestMapping(value = "/add", method = RequestMethod.POST) public String addContact(@ModelAttribute("contact") Contact contact) { if(contact.getId() == null) contactService.add(contact); else contactService.update(contact); return "redirect:/"; } @RequestMapping(value = "/edit", method = RequestMethod.GET) public ModelAndView showEditForm(@RequestParam(required = true) Long id) { return new ModelAndView("add_form", "contact", contactService.get(id)); } @RequestMapping(value = "/delete", method = RequestMethod.GET) public String deleteContact(@RequestParam(required = true) Long id) { contactService.remove(id); return "redirect:/"; } }
      
      





さて、そしてビュー:



src / webapp / WEB-INF / pages / add_form.jsp
 <%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %> <%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title> </title> </head> <body> <form:form method="POST" action="/add" modelAttribute="contact"> <form:hidden path="id" /> <table> <tr> <td>Name:</td> <td><form:input path="name" /></td> </tr> <tr> <td>Number:</td> <td><form:input path="number" /></td> </tr> <tr> <td>E-mail:</td> <td><form:input path="email" /></td> </tr> <tr> <td colspan="2"> <input type="submit" /> </td> </tr> </table> </form:form> </body> </html>
      
      





別のもの:



src / webapp / WEB-INF / all.jsp
 <%@ page contentType="text/html;charset=UTF-8" language="java" %> <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> <html> <head> <title> </title> </head> <body> <table width="600px"> <tr> <td><b>ID</b></td> <td><b>Name</b></td> <td><b>Number</b></td> <td><b>E-mail</b></td> <td><b>Action</b></td> </tr> <c:forEach var="contact" items="${contacts}"> <tr> <td>${contact.id}</td> <td>${contact.name}</td> <td>${contact.number}</td> <td>${contact.email}</td> <td><a href="/edit?id=${contact.id}">Edit</a> | <a href="/delete?id=${contact.id}">Delete</a></td> </tr> </c:forEach> <tr> <td colspan="5"> <a href="/add"> </a> </td> </tr> </table> </body> </html>
      
      







それですべてです。プロジェクトを収集し、立ち上げて、出来上がりです。





ソースへのリンク: github.com/ruslanys/sample-spring-mongodb



PS誰かがこの投稿を手伝ってくれたら嬉しいです。 ヒントと修正に感謝します。



UPD。 Habrからの同志の推薦で、すべてのリストをネタバレにした。



All Articles