时间:2018年5月26日
目的:
搭建一个简单的ssm框架,提升自己对ssm框架的理解。
基本步骤:
1、创建web工程
2、导入ssm相关jar包
3、利用mybatis的generator逆向工程,生成dao接口、xml文件、实体类
4、配置xml相关文件
5、编写service层
6、测试service以及dao层
7、编写controller
8、测试控制层
说明: 控制层接口采用Restful风格、测试采用junit注解、框架会尽自己能力,尽量做到规范一些。
开发工具说明:
Eclipse Oxygen
jdk 1.8
tomcat:8.0
1、创建web工程
以下是项目最终的目录结构
创建动态web工程,创建两个source folder 一个放主代码, 一个放各类资源文件
2、导入ssm相关jar包
不复杂,故不赘述。
jar包可以考虑采用UserLibrary的方式导入,这样项目转移(jar包整体带走),也不会报错,浪费时间配置所有的jar包
说明: 日志采用log4j、 数据库连接的sql server
扩展:jar包可以访问https://mvnrepository.com/ maven仓库地址,关键词搜索,查询自己所需要的jar包。
3、利用mybatis的generator逆向工程,生成dao接口、xml文件、实体类
说明:
1、用户当然可以自行编写
dao接口、xml文件、实体类,但是会花费相当多的时间和精力。 而利用逆向工程,则可以节省很多时间。
2、 逆向工程一般是自己新建一个简单的工程,自动生成持久层相关文件,然后,再按需将所需要的文件导入正式的项目里, 而非在当前项目里直接生成。
可以参考我之前写的博客,里面提供了两种方式:MyBatis逆向工程,自动生成dao、实体类、mapper文件
4、配置xml相关文件
配置属性文件,分离数据库连接的信息,便于维护---- jdbc.propert
jdbc.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver
jdbc.url=jdbc:sqlserver://localhost;databaseName=loraBase
jdbc.username=sa
jdbc.password=123
initialSize=0
maxActive=20
maxIdle=20
minIdle=1
maxWait=60000
配置数据库连接、事务处理、整合Mybatis等: spring-mybatis.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:p="http://www.springframework.org/schema/p"
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-3.1.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.1.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
<!-- 自动扫描 -->
<!-- 此处扫描 不用包含mvc控制层,在spring-mvc配置文件,可以单独对其进行配置扫描, 按需来配置要好一些,毕竟统一配置,项目大了可能会影响性能,思路更清晰,明白你具体都都做了些啥 -->
<context:component-scan base-package="com.ssm.domain" />
<context:component-scan base-package="com.ssm.dao" />
<context:component-scan base-package="com.ssm.service" />
<!-- 引入配置文件 jdbc.properties-->
<bean id="propertyConfigurer"
class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="location" value="classpath:properties/jdbc.properties" />
</bean>
<!-- 连接池配置 -->
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
destroy-method="close">
<property name="driverClassName" value="${jdbc.driverClassName}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
<!-- 初始化连接大小 -->
<property name="initialSize" value="${initialSize}"></property>
<!-- 连接池最大数量 -->
<property name="maxActive" value="${maxActive}"></property>
<!-- 连接池最大空闲 -->
<property name="maxIdle" value="${maxIdle}"></property>
<!-- 连接池最小空闲 -->
<property name="minIdle" value="${minIdle}"></property>
<!-- 获取连接最大等待时间 -->
<property name="maxWait" value="${maxWait}"></property>
</bean>
<!-- spring和MyBatis完美整合,不需要mybatis的配置映射文件 -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<!-- 自动扫描mapping.xml文件 -->
<property name="mapperLocations" value="classpath:com/ssm/dao/xml/*.xml"></property>
</bean>
<!-- DAO接口所在包名,Spring会自动查找其下的类 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.ssm.dao" />
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
</bean>
<!-- (事务管理)transaction manager, use JtaTransactionManager for global tx -->
<bean id="transactionManager"
class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataSource" />
</bean>
</beans>
配置spring mvc相关信息,视图解析器、开启注解扫描等 ---- spring-mvc.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:p="http://www.springframework.org/schema/p"
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-3.1.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.1.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
<!-- 自动扫描该包,使SpringMVC认为包下用了@controller注解的类是控制器 -->
<context:component-scan base-package="com.ssm.web" />
<!-- 会自动注册RequestMappingHandlerMapping与RequestMappingHandlerAdapter两个Bean, -->
<!-- 这是Spring MVC为@Controller分发请求所必需的, -->
<!-- 并且提供了数据绑定支持,@NumberFormatannotation支持,@DateTimeFormat支持, -->
<!-- @Valid支持读写XML的支持(JAXB)和读写JSON的支持(默认Jackson)等功能。 -->
<mvc:annotation-driven />
<!--避免IE执行AJAX时,返回JSON出现下载文件 -->
<bean id="mappingJacksonHttpMessageConverter"
class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<property name="supportedMediaTypes">
<list>
<value>text/html;charset=UTF-8</value>
</list>
</property>
</bean>
<!-- 启动SpringMVC的注解功能,完成请求和注解POJO的映射 -->
<bean
class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
<property name="messageConverters">
<list>
<ref bean="mappingJacksonHttpMessageConverter" /> <!-- JSON转换器 -->
</list>
</property>
</bean>
<!-- 视图解析器 -->
<!-- 定义跳转的文件的前后缀 ,视图模式配置 -->
<bean
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!-- 这里的配置我的理解是自动给后面action的方法return的字符串加上前缀和后缀,变成一个 可用的url地址 -->
<property name="prefix" value="/WEB-INF/pages/" />
<property name="suffix" value=".jsp" />
</bean>
<!--对静态资源文件的访问 -->
<!-- 针对springMVC的restful风格的url而言,配置了 -->
<mvc:resources mapping="/images/**" location="/WEB-INF/images/" />
<mvc:resources mapping="/css/**" location="/WEB-INF/css/" />
<mvc:resources mapping="/js/**" location="/WEB-INF/js/" />
</beans>
配置web.xml文件
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
id="WebApp_ID" version="3.0">
<display-name>IOTDemo</display-name>
<!--定制默认首页,一般可以设置为登陆或者index -->
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
<!--springMVC的核心分发器 -->
<servlet>
<servlet-name>spring-mvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!-- 指定Spring的配置文件 -->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring/spring-mvc.xml</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>spring-mvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<!-- spring容器配置 -->
<context-param>
<param-name>contextConfigLocation</param-name>
<!-- 注意,spring加载配置文件 -->
<param-value>
classpath:spring/spring-mybatis.xml,
</param-value>
</context-param>
<!-- spring容器监听器 -->
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<!-- charactor encoding -->
<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>
</filter>
<filter-mapping>
<filter-name>encodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
扩展:
1、mvc核心配置信息主要是控制层的文件包扫描、视图解析器、和<mvc:annotation-driven />
2、当url采用restful风格时,可能会导致springMVC会拦截静态资源,这时就需要配置一下,让静态资源可以访问
3、<mvc:resources mapping="/images/**" location="/WEB-INF/images/" /> 当文件为了提高安全性
放在WEB-INF下面时,就需要注意路径的正确性
配置日志文件输出,可以输出再控制台、文本文件,配置丰富。 甚至可以配置信息存入数据库。----log4j.properties
log4j.rootLogger = info,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 = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
5、
编写service层
1、要在类名上标记注解@Service
2、一般可以考虑在Service层导入日志功能,输出各类信息。
3、依赖注入:@Resource或者@Autowired两种方式,别人推荐都是@Autowired
扩展: 一般可以考虑dao层,方法名直接就是增删改查selectXXX、addXXX、deleteXXX、updateXXX等。
service层可以考虑,从用户的角度去对方法命名。比如:登陆--login(),比如注册--register(),比如:执行秒杀:executeSecKill().....:
6、测试service以及dao层
1、一般编写完Service层和Dao层以后,就可以进行测试,推荐使用Junt注解单元测试
2、
需要导入spring-test的jar包,便于依赖注入(已经被托管,所以dao和service是无法new的)
3、建议使用快捷方式,按类自动生成所有方法的测试文件。优雅而且方便
4、其他获取springde 实例对象的方式可以参考如下:
简单的在类文件里用ApplicationContext获得Spring中定义的Bean实例(对象):
ApplicationContext ac = new ClassPathXmlApplicationContext("applicationContext.xml");
TestDao testDAO = (TestDao )ac.getBean("TestDao ");
如果是两个以上配置文件:
ApplicationContext ac = new ClassPathXmlApplicationContext(new String[]{"applicationContext.xml","spring-mybatis.xml"});
或者用通配符:
ApplicationContext ac = new ClassPathXmlApplicationContext("classpath:/*.xml");
测试流程:
1、选择需要测试的类:dao或者service的实现类
2、右键,找到 Junit Test Case
。。。
new:
java文件夹下面的Junit文件夹里
package默认在当前dao或者service里,推荐建立新的test包
注意选完包名要记得点击Next,不要点击Finish
勾选选择所有的方法!
结果:(带上了asert断言相关语句代码)
接下来就是配置Spring-Test相关注解,引入dao和service进行测试!
1、@RunWith(SpringJUnit4ClassRunner.class);
2、@ContestConfiguration(locations = { "classpath:spring/spring-mybatis.xml" }); 获取相关配置文件,不需要导入mvc相关的配置文件,支持多配置文件的导入
3、直接利用@Autowired注入dao或者Service
4、可以考虑引入logger,来进行数据的打印,,而非System.out.println()
7、编写controller
说明1:
1、控制层与外部的数据传输,模板采用了DTO(data transfer object),即,用户需要什么数据,我就在这个模板里给你封装什么数据,与实体类由一定的区别
;
2、控制层的包命名采用com.xxx.web.xxx的方式,便于后期的维护,比如与app相关的我叫:com.xxx.web.app,一般的接口:com.xxx.web.api
3、
静态资源放在了WEB-INF下面,所以需要spring-mvc.xml
的配置文件里配置允许静态资源的访问。
4、和页面放在了WEB-INF下面,所以,每个页面的访问,都需要请求服务端的controller
说明2:
1、controller采用restful风格,所以一般请求都是名词,动作交给http的GET、POST、PUT、等来表述。行为采用动词表述
2、请求路径:最好在类名上也编写,实现模块化
3、Model 、ModelAndView、 HttpServletRequest、基本数据类型、实体对象、Map都可以作为参数传入方法
4、@RequestMapping()里面,路径都用value=“”,访问方式都进行说明,采用post还是get,
5、@RequestMapping()里面,可以给一个方法,配置多个路径访问它
6、返回json数据,可以加上produces = { "application/json;charset=utf-8" },进行标记,表明这是json数据
7、提高代码健壮性,注意try-catch的灵活应用
8、注意方法注释的编写,尤其是service层和controller层! 因为项目是一个团队在开发,注释详写,对人对己都有好处
9、@PathVariable RestFul风格参数直接在url里,/iot/details/{userId} ,需要用(@PathVariable(“userId”) int userId)进行参数的获取
dto封装前端所需要的数据,在service层进行获取,controller进行返回
1、dto 配置json数据返回通用格式,即数据获取是否成功,错误信息, data数据(泛型T的使用,使得该方法更灵活)
2、重载构造函数,以便在其他方法里,便捷优雅的实现数据的封装