idea整合restful风格的ssm框架(一)
1. 前言
自己从一个萌新开始,经历了从网上到处找相关框架的搭建教程学习,再到公司上班后也了解到完善项目中的框架体系。为了总结一下自己学习过程,和搭建一个以后可扩展和使用的通用框架,当然还有一个重要原因是帮助另一位萌新做毕业设计,在搭建好框架后也准备写这篇文章记录记录。
为了让萌新能够看懂,当然也为了大家能够更直接方便的复制即可用,这篇文章会从较新手的角度叙述。各位大大若有看到,不喜勿喷。
2. 简介
在这里大概先对几个框架做个介绍,想详细了解的请另行百度。
SSM框架,是Spring + Spring MVC + MyBatis的缩写,这个是继SSH之后,目前比较主流的Java EE企业级框架,适用于搭建各种大型的企业级应用系统。
2.1 spring
Spring是一个开源框架,Spring是于2003年兴起的一个轻量级的Java开发框架,由Rod Johnson在其著作Expert One-On-One J2EE Development and Design中阐述的部分理念和原型衍生而来。它是为了解决企业应用开发的复杂性而创建的。Spring使用基本的JavaBean来完成以前只可能由EJB完成的事情。然而,Spring的用途不仅限于服务器端的开发。从简单性、可测试性和松耦合的角度而言,任何Java应用都可以从Spring中受益。 简单来说,Spring是一个轻量级的控制反转(IoC)和面向切面(AOP)的容器框架。
2.2 spring mvc
Spring MVC属于Spring Framework的后续产品,已经融合在Spring Web Flow里面,它原生支持的Spring特性,让开发变得非常简单规范。Spring MVC 分离了控制器、模型对象、分派器以及处理程序对象的角色,这种分离让它们更容易进行定制。
2.3 mybatis
MyBatis本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code,并且改名为MyBatis 。MyBatis是一个基于Java的持久层框架。iBATIS提供的持久层框架包括SQL Maps和Data Access Objects(DAO)MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis使用简单的XML或注解用于配置和原始映射,将接口和Java的POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。可以这么理解,MyBatis是一个用来帮你管理数据增删改查的框架。
2.4 maven
Maven是一个项目管理和整合的工具。Maven为开发者提供了一套完整的构建生命周期框架。开发团队基本不用花多少时间就能自动完成工程的基础构建配置,因为Maven使用了一个标准的目录结构和一个默认的构建生命周期。在创建报告、检查、构建和测试自动配置时,Maven可以让开发者的工作变得更简单。
简单来说我们这里用到的就是构建项目和下载依赖包,后面的发布这些请自行研究
2.5 restful风格
一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。这里引用一篇对restful风格讲解很不错的文章
restfu风格
3. 环境
相关环境:jdk 1.7、maven 3.5、 tomcat 7
编译器:idea
在这里默认java环境已经搭建完成,若环境还存在问题的看官请移步百度,先把环境搭建完成。
3.1 idea集成maven
File->Settings
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/4ec568d8a1284d3b815c3261fe78df95/b116031a9822.png
maven.png
3.2 idea集成jdk
File->Settings
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/e88e37ee5b1c4937bbc2c820c8fe87ef/6ebd0a32da7e.png
jdk.png
3.3 idea集成tomcat
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/55987019974a4b0b890d2127c47bc318/e3acbaf34126.png
tomcat1.png
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/889d5fac1b954b28abf9da9b9d59a46c/b07e87984324.png
tomcat2.png
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/c76e8a2311144ee798ad4f8899c0859c/c74e113f4cfa.png
tomcat3.png
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/73cb1cb865764785bafcd78afe7d43ff/d917521c6acf.png
tomcat4.png
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/d7afbbd64e6a47f29dbf13125468e57d/17c1c163f8db.png
tomcat5.png
tomcat已配置成功,配置成功后如下图,启动项目和调试项目
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/0298d28ea3f84807bb0fe6e596a96d67/6ad5d3cc3f36.png
tomcat6.png
4. 框架搭建
先上一个已经搭建完成的框架结构图,后面一边写再一边重新搭建一个。
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/145b4ee080fe40ffb579c872fa450710/25ce29374b2a.png
项目结构.png
4.1 新建项目
项目使用idea开发,所以所有操作都是在idea编译器中进行。
File->New->Project ,选择maven项目的webapp,然后next
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/0c6660b54fcd4628b26838ee76b029f7/df1b36e4df98.png
新建项目.PNG
在这里填写groupid和artifactid
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/ce9263e2c1fd44dcbad4c01f0eacf98f/78f8a87805ee.png
groupid.png
然后一路next,即可看见项目已经搭建成功,这是现在的项目架构,除了看到web.xml什么也没有
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/78124bd1021f4460a1a037e2a562f178/1eabc14fca56.png
空架构图.png
在main下面创建一个java文件夹:main->右键New->Directory,文件夹名java
并把它作为项目源代码文件夹:File->Project Structure -> Modules->Sources
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/4d7a4b4866534f96ac96a17835c9b5a5/8fa69347ba03.png
建立main.png
4.2 配置maven依赖
在这里我引入的依赖较多,便于后面的扩展,大部分都有注释。可根据自己需要删除无用的或者修改版本。在这里有个注意的地方,spring相关的依赖,版本都要一致,不然会出问题。
pom.xml(从<dependencies>开始)
<dependencies> <!--servletAPI--> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>3.1.0</version> <scope>provided</scope> </dependency> <!--spring--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>4.2.5.RELEASE</version> </dependency> <!--springWEB--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>4.2.5.RELEASE</version> </dependency> <!--springMVC--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>4.2.5.RELEASE</version> </dependency> <!--spring tx 事务处理--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-tx</artifactId> <version>4.2.5.RELEASE</version> </dependency> <!--spring aop--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-aop</artifactId> <version>4.2.5.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-aspects</artifactId> <version>4.2.5.RELEASE</version> </dependency> <!--spring-jdbc--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-jdbc</artifactId> <version>4.2.5.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> <version>4.2.5.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> <version>4.2.5.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>4.2.5.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-orm</artifactId> <version>4.2.5.RELEASE</version> </dependency> <!--jstl--> <dependency> <groupId>javax.servlet</groupId> <artifactId>jstl</artifactId> <version>1.2</version> </dependency> <!--log4j--> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> <!--mybatis--> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.4.1</version> </dependency> <!--mybatis spring整合包--> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> <version>1.3.0</version> </dependency> <!--c3p0链接池--> <dependency> <groupId>com.mchange</groupId> <artifactId>c3p0</artifactId> <version>0.9.5.2</version> </dependency> <!--Mysql数据库驱动--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.41</version> </dependency> <dependency> <groupId>org.jetbrains</groupId> <artifactId>annotations-java5</artifactId> <version>RELEASE</version> </dependency> <dependency> <groupId>org.codehaus.jackson</groupId> <artifactId>jackson-mapper-asl</artifactId> <version>1.9.13</version> </dependency> <dependency> <groupId>org.codehaus.jackson</groupId> <artifactId>jackson-core-asl</artifactId> <version>1.9.13</version> </dependency> <dependency> <groupId>org.codehaus.jackson</groupId> <artifactId>jackson-core-asl</artifactId> <version>1.9.13</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.6.6</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-annotations</artifactId> <version>2.6.0</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-core</artifactId> <version>2.6.6</version> </dependency> <!--fastjson--> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.40</version> </dependency> </dependencies>
4.3 配置web.xml
在这里主要配置spring mvc的前端控制器mvc-dispatcher,这里的classpath:ssm.xml是配置在resources下面的spring相关配置的xml,这里直接把spring和springmvc的相关东西都配置ssm.xml中。<url-pattern>/api/* </url-pattern>中/api/*是接口的请求路径,后面会用到
web.xml
<web-app xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0"> <display-name>ssm</display-name> <servlet> <servlet-name>mvc-dispatcher</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:ssm.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>mvc-dispatcher</servlet-name> <url-pattern>/api/*</url-pattern> </servlet-mapping> <welcome-file-list> <welcome-file>login.html</welcome-file> </welcome-file-list></web-app>
4.4 配置ssm.xml- 在java目录下新建com.bgy.ssm包放置java代码
- 在resources目录下创建sql-mapping文件夹放置mybatis的sql映射文件,为了ssm.xml中配置不报错,先建一个user.xml的文件放在里面,暂时不写东西
- 在resources目录下创建sql-map-config.xml文件,配置mybatis相关属性
sql-map-config.xml
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"><configuration> <settings> <setting name="cacheEnabled" value="true"/> <setting name="lazyLoadingEnabled" value="true"/> <setting name="multipleResultSetsEnabled" value="true"/> <setting name="useColumnLabel" value="true"/> <setting name="defaultExecutorType" value="REUSE"/> <setting name="defaultStatementTimeout" value="25000"/> </settings></configuration>- 在resources目录下创建ssm.properties文件配置数据库链接,这里我使用的是本地的数据库,改为自己的数据库用户和密码即可
ssm.properties
driverClass=com.mysql.jdbc.DriverjdbcUrl=jdbc:mysql://127.0.0.1:3306/gcsj?characterEncoding=utf8database_user=rootdatabase_password=root- 在resources目录下新建ssm.xml文件,配置spring和springmvc的东西,其中每个都写了注释,若想深入理解的可再去查阅资料,也有些这个框架中暂时用不到的。
ssm.xml
<?xml version="1.0" encoding="UTF-8"?><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" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:task="http://www.springframework.org/schema/task" xmlns:jdbc="http://www.springframework.org/schema/jdbc" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.1.xsd http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd"> <!--激活那些已经在spring容器里注册过的bean(无论是通过xml的方式还是通过package sanning的方式)上面的注解。--> <context:annotation-config /> <!--指定的package下扫描以及注册javabean--> <context:component-scan base-package="com.bgy.ssm"/> <!--参数配置文件是以properties为后缀的--> <context:property-placeholder location="classpath*:*.properties"/> <!--自动注册spring mvc的一些bean,具体可百度详查--> <mvc:annotation-driven/> <!--进行静态资源的访问--> <mvc:resources mapping="/resources/**" location="/resources/"/> <!--数据库连接池,c3p0--> <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource " destroy-method="close"> <property name="driverClass" value="${driverClass}" /> <property name="jdbcUrl" value="${jdbcUrl}" /> <property name="user" value="${database_user}" /> <property name="password" value="${database_password}" /> <property name="acquireIncrement" value="1" /> <property name="initialPoolSize" value="5" /> <property name="maxPoolSize" value="20" /> <property name="minPoolSize" value="5" /> <property name="maxStatements" value="100" /> <property name="testConnectionOnCheckout" value="true" /> </bean> <!--配置mybatis的sqlSessionFactory--> <!--sql-map-config.xml是mybatis的相关配置,sql-mapping/*.xml是sql的映射文件--> <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <property name="dataSource" ref="dataSource" /> <property name="configLocation" value="classpath:sql-map-config.xml" /> <property name="mapperLocations" value="classpath:sql-mapping/*.xml" /> </bean> <!--配置扫描加了MybatisSqlMapping注解的interface,并生成mapper对象--> <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <property name="basePackage" value="com.bgy.ssm" /> <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" /> <property name="annotationClass" value="com.bgy.ssm.anotation.MybatisSqlMapping" /> </bean> <!--spring的事务配置--> <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> <property name="dataSource" ref="dataSource" /> </bean> <!--支持事务注解的(@Transactional)?--> <tx:annotation-driven /> <!--声明自动为spring容器中那些配置@aspectJ切面的bean创建代{过}{滤}理,织入切面--> <aop:aspectj-autoproxy /> <!--注册controllerAspect的bean,这个bean用于拦截controller的异常--> <bean id="controllerAspect" class="com.bgy.ssm.aspect.ControllerAspect" /></beans>
至此,整个项目的框架已经搭建完毕。
先来跑一下看看
D:/Program%20Files%20%28x86%29/Youdao/LocalhostNote/qq78C8518BC5D463BD7E3FB0054D3645CF/cf6726320c1a4abfa8fa8aa0bc79e38a/376658b7152d.png
run1.png
点启动项目后项目可正常访问index.jsp,到目前配置无错误 |