一步步教你寫一個(gè)SpringMVC框架
一、介紹
在日常的 web 開發(fā)中,熟悉 java 的同學(xué)一定知道,Spring MVC 可以說是目前最流行的框架,之所以如此的流行,原因很簡單:編程簡潔、上手簡單!
我記得剛開始入行的時(shí)候,最先接觸到的是Struts1 + Hibernate + Spring來web系統(tǒng)的整體開發(fā)框架,簡單的描述一下當(dāng)時(shí)的編程心情:超難用,各種配置項(xiàng)很多,而且不容易快速入手!
之后,新的項(xiàng)目換成了Struts2 + hibernate + spring來作為主體開發(fā)框架,Struts2相比Struts1編程要簡單很多,而且加強(qiáng)了對(duì)攔截器與IoC的支持,而在Struts1中,這些特性是很難做的的!
然而隨著Struts2的使用量越來越廣,業(yè)界爆出關(guān)于Struts2的bug和安全漏洞卻越來越多!
黑客們可以輕易的利用安全漏洞直接繞開安全防線,獲取用的隱私數(shù)據(jù),網(wǎng)名因個(gè)人信息泄露造成的經(jīng)濟(jì)損失高達(dá) 915 億元!
至此很多開發(fā)者開始轉(zhuǎn)到SpringMVC框架陣營!
今天我們要介紹的主角就是SpringMVC框架,剛開始玩這個(gè)的時(shí)候,給我最直接的感覺就是:很容易簡單!
直接通過幾個(gè)注解就可以完成方法的暴露,比起Struts2中繁瑣的xml配置,SpringMVC的使用可以說更加友好!
熟悉SpringMVC框架的同學(xué)一定清楚下面這張圖,
這張圖就是 SpringMVC 在處理 http 請(qǐng)求的整個(gè)流程中所做的一些事情。
- 1、用戶發(fā)送請(qǐng)求至前端控制器DispatcherServlet
- 2、DispatcherServlet收到請(qǐng)求調(diào)用HandlerMapping處理器映射器。
- 3、處理器映射器根據(jù)請(qǐng)求url找到具體的處理器,生成處理器對(duì)象及處理器攔截器(如果有則生成)一并返回給DispatcherServlet。
- 4、DispatcherServlet通過HandlerAdapter處理器適配器調(diào)用處理器
- 5、執(zhí)行處理器(Controller,也叫后端控制器)。
- 6、Controller執(zhí)行完成返回ModelAndView
- 7、HandlerAdapter將controller執(zhí)行結(jié)果ModelAndView返回給DispatcherServlet
- 8、DispatcherServlet將ModelAndView傳給ViewReslover視圖解析器
- 9、ViewReslover解析后返回具體View
- 10、DispatcherServlet對(duì)View進(jìn)行渲染視圖(即將模型數(shù)據(jù)填充至視圖中)。
- 11、DispatcherServlet響應(yīng)用戶。
DispatcherServlet 主要承擔(dān)接收請(qǐng)求、響應(yīng)結(jié)果、轉(zhuǎn)發(fā)等作用,剩下的就交給容器來處理!
基于上面的流程,我們可以編寫出一款簡化版的Spring MVC框架,話不多說,直接擼起來!
二、程序?qū)嵺`
首先上圖!
這個(gè)就是我們簡易版的Spring MVC框架的實(shí)現(xiàn)流程圖!
1、首先創(chuàng)建一個(gè)DispatcherServlet類,在服務(wù)啟動(dòng)的時(shí)候,讀取要掃描的包路徑,然后通過反射將類信息存儲(chǔ)到ioc容器,同時(shí)通過@Autowired注解,實(shí)現(xiàn)自動(dòng)依賴注入,最后讀取@RequestMapping注解中的方法,將映射路徑與類的關(guān)系存儲(chǔ)到映射容器中。
2、當(dāng)用戶發(fā)起請(qǐng)求的時(shí)候,通過請(qǐng)求路徑到映射容器中找到對(duì)應(yīng)的執(zhí)行類,然后調(diào)用具體的方法,發(fā)起邏輯處理,最后將處理結(jié)果返回給前端用戶!
以下是具體實(shí)踐過程!
2.1、創(chuàng)建掃描注解
因?yàn)镾pring MVC基本全部都是基于注解開發(fā),因此我們事先也需要?jiǎng)?chuàng)建對(duì)應(yīng)的注解,各個(gè)含義與Spring MVC一致!
控制層注解
/** * 控制層注解 * @Controller */ @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Controller { String value() default ""; }
請(qǐng)求路徑注解
/** * 請(qǐng)求路徑注解 * @RequestMapping */ @Target({ElementType.METHOD,ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface RequestMapping { String value() default ""; }
參數(shù)注解
/** * 參數(shù)注解 * @RequestParam */ @Target({ElementType.PARAMETER}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface RequestParam { String value() default ""; }
服務(wù)層注解
/** * 服務(wù)層注解 * @Controller */ @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Service { String value() default ""; }
自動(dòng)裝載注解
/** * 自動(dòng)裝載注解 * @Autowrited */ @Target({ElementType.FIELD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Autowired { String value() default ""; }
2.2、編寫 DispatcherServlet 類
DispatcherServlet是一個(gè)Servlet類,主要承擔(dān)的任務(wù)是:接受前端用戶的請(qǐng)求,然后進(jìn)行轉(zhuǎn)發(fā),最后響應(yīng)結(jié)果給前端用戶!
詳細(xì)代碼如下:
/** * servlet跳轉(zhuǎn)層 */ @WebServlet(name = "DispatcherServlet",urlPatterns = "/*", loadOnStartup = 1, initParams = {@WebInitParam(name="scanPackage", value="com.example.mvc")}) public class DispatcherServlet extends HttpServlet { private static final long serialVersionUID = 1L; private static final Logger logger = LoggerFactory.getLogger(DispatcherServlet.class); /**請(qǐng)求方法映射容器*/ private static List<RequestHandler> handlerMapping = new ArrayList<>(); /** * 服務(wù)啟動(dòng)的時(shí)候,進(jìn)行初始化,流程如下: * 1、掃描指定包下所有的類 * 2、通過反射將類實(shí)例,放入ioc容器 * 3、通過Autowired注解,實(shí)現(xiàn)自動(dòng)依賴注入,也就是set類中的屬性 * 4、通過RequestMapping注解,獲取需要映射的所有方法,然后將類信息存放到容器中 * @param config * @throws ServletException */ @Override public void init(ServletConfig config) throws ServletException { try { //1、掃描指定包下所有的類 String scanPackage = config.getInitParameter("scanPackage"); //1、掃描指定包下所有的類 List<String> classNames = doScan(scanPackage); //2、初始化所有類實(shí)例,放入ioc容器,也就是map對(duì)象中 Map<String, Object> iocMap = doInstance(classNames); //3、實(shí)現(xiàn)自動(dòng)依賴注入 doAutowired(iocMap); //5、初始化方法mapping initHandleMapping(iocMap); } catch (Exception e) { logger.error("dispatcher-servlet類初始化失敗!",e); throw new ServletException(e.getMessage()); } } /** * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response) */ protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException { doPost(request, response); } /** * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response) */ protected void doPost(HttpServletRequest request, HttpServletResponse response) throws IOException { //跳轉(zhuǎn) doDispatch(request, response); } /** * 掃描指定包下的類文件 * @param packageName * @return */ private List<String> doScan(String packageName){ if(StringUtils.isBlank(packageName)){ throw new RuntimeException("mvc配置文件中指定掃描包名為空!"); } return PackageHelper.getClassName(packageName); } private Map<String, Object> doInstance(List<String> classNames) { Map<String, Object> iocMap = new HashMap<>(); if(!CollectionUtils.isNotEmpty(classNames)){ throw new RuntimeException("獲取的類為空!"); } for (String className : classNames) { try { //通過反射機(jī)制構(gòu)造對(duì)象 Class<?> clazz = Class.forName(className); if(clazz.isAnnotationPresent(Controller.class)){ //將類名第一個(gè)字母小寫 String baneName = firstLowerCase(clazz.getSimpleName()); iocMap.put(baneName, clazz.newInstance()); }else if(clazz.isAnnotationPresent(Service.class)){ //服務(wù)層注解判斷 Service service = clazz.getAnnotation(Service.class); String beanName = service.value(); //如果該注解上沒有自定義類名,則默認(rèn)首字母小寫 if(StringUtils.isBlank(beanName)){ beanName = clazz.getName(); } Object instance = clazz.newInstance(); iocMap.put(beanName, instance); //如果注入的是接口,可以巧妙的用接口的類型作為key Class<?>[] interfaces = clazz.getInterfaces(); for (Class<?> clazzInterface : interfaces) { iocMap.put(clazzInterface.getName(), instance); } } } catch (Exception e) { logger.error("初始化mvc-ioc容器失敗!",e); throw new RuntimeException("初始化mvc-ioc容器失敗!"); } } return iocMap; } /** * 實(shí)現(xiàn)自動(dòng)依賴注入 * @throws Exception */ private void doAutowired(Map<String, Object> iocMap) { if(!MapUtils.isNotEmpty(iocMap)){ throw new RuntimeException("初始化實(shí)現(xiàn)自動(dòng)依賴失敗,ioc為空!"); } for(Map.Entry<String, Object> entry : iocMap.entrySet()){ //獲取對(duì)象下所有的屬性 Field[] fields = entry.getValue().getClass().getDeclaredFields(); for (Field field : fields) { //判斷字段上有沒有@Autowried注解,有的話才注入 if(field.isAnnotationPresent(Autowired.class)){ try { Autowired autowired = field.getAnnotation(Autowired.class); //獲取注解上有沒有自定義值 String beanName = autowired.value().trim(); if(StringUtils.isBlank(beanName)){ beanName = field.getType().getName(); } //如果想要訪問到私有的屬性,我們要強(qiáng)制授權(quán) field.setAccessible(true); field.set(entry.getValue(), iocMap.get(beanName)); } catch (Exception e) { logger.error("初始化實(shí)現(xiàn)自動(dòng)依賴注入失敗!",e); throw new RuntimeException("初始化實(shí)現(xiàn)自動(dòng)依賴注入失敗"); } } } } } /** * 初始化方法mapping */ private void initHandleMapping(Map<String, Object> iocMap){ if(!MapUtils.isNotEmpty(iocMap)){ throw new RuntimeException("初始化實(shí)現(xiàn)自動(dòng)依賴失敗,ioc為空"); } for(Map.Entry<String, Object> entry:iocMap.entrySet()){ Class<?> clazz = entry.getValue().getClass(); //判斷是否是controller層 if(!clazz.isAnnotationPresent(Controller.class)){ continue; } String baseUrl = null; //判斷類有沒有requestMapping注解 if(clazz.isAnnotationPresent(RequestMapping.class)){ RequestMapping requestMapping = clazz.getAnnotation(RequestMapping.class); baseUrl= requestMapping.value(); } Method[] methods = clazz.getMethods(); for (Method method : methods) { //判斷方法上有沒有requestMapping if(!method.isAnnotationPresent(RequestMapping.class)){ continue; } RequestMapping requestMethodMapping = method.getAnnotation(RequestMapping.class); //"/+",表示將多個(gè)"/"轉(zhuǎn)換成"/" String regex = (baseUrl + requestMethodMapping.value()).replaceAll("/+", "/"); Pattern pattern = Pattern.compile(regex); handlerMapping.add(new RequestHandler(pattern, entry.getValue(), method)); } } } /** * servlet請(qǐng)求跳轉(zhuǎn) * @param request * @param response * @throws IOException */ private void doDispatch(HttpServletRequest request, HttpServletResponse response) throws IOException { try { request.setCharacterEncoding("UTF-8"); response.setHeader("Cache-Control", "no-cache"); response.setHeader("Pragma", "no-cache"); response.setDateHeader("Expires", -1); response.setContentType("text/html"); response.setHeader("content-type", "text/html;charset=UTF-8"); response.setCharacterEncoding("UTF-8"); RequestHandler handle = getHandleMapping(request); if(Objects.isNull(handle)){ //異常請(qǐng)求地址 logger.warn("異常請(qǐng)求地址!地址:" + request.getRequestURI()); response.getWriter().append("error request url"); return; } //獲取參數(shù)列表 Object[] paramValues = RequestParamHelper.buildRequestParam(handle, request, response); Object result = handle.getMethod().invoke(handle.getController(), paramValues); if(result != null){ PrintWriter out = response.getWriter(); out.println(result); out.flush(); out.close(); } } catch (Exception e) { logger.error("接口請(qǐng)求失敗!",e); PrintWriter out = response.getWriter(); out.println("請(qǐng)求異常,請(qǐng)稍后再試"); out.flush(); out.close(); } } /** * 將類名第一個(gè)字母小寫 * @param clazzName * @return */ private String firstLowerCase(String clazzName){ char[] chars = clazzName.toCharArray(); chars[0] += 32; return String.valueOf(chars); } /** * 獲取用戶請(qǐng)求方法名 * 與handlerMapping中的路徑名進(jìn)行匹配 * @param request * @return */ private RequestHandler getHandleMapping(HttpServletRequest request){ if(CollectionUtils.isNotEmpty(handlerMapping)){ //獲取用戶請(qǐng)求路徑 String url = request.getRequestURI(); String contextPath = request.getContextPath(); String serviceUrl = url.replace(contextPath, "").replaceAll("/+", "/"); for (RequestHandler handle : handlerMapping) { //正則匹配請(qǐng)求方法名 Matcher matcher = handle.getPattern().matcher(serviceUrl); if(matcher.matches()){ return handle; } } } return null; } }
這里要重點(diǎn)介紹一下初始化階段所做的操作!
DispatcherServlet在服務(wù)啟動(dòng)階段,會(huì)調(diào)用init方法進(jìn)行服務(wù)初始化,此階段所做的事情主要有以下內(nèi)容:
- 1、掃描指定包下所有的類信息,返回的結(jié)果主要是包名 + 類名
- 2、通過反射機(jī)制,將類進(jìn)行實(shí)例化,將類實(shí)例化對(duì)象存儲(chǔ)到ioc容器中,其中key是類名(小些駝峰),value是類對(duì)象
- 3、通過Autowired注解找到類對(duì)象中的屬性,通過小駝峰從ioc容器中尋找對(duì)應(yīng)的屬性值,然后進(jìn)行set操作
- 4、通過Controller和RequestMapping注解尋找需要暴露的方法,并獲取對(duì)應(yīng)的映射路徑,最后將映射路徑
- 5、最后,當(dāng)前端用戶發(fā)起一個(gè)請(qǐng)求時(shí),DispatcherServlet獲取到請(qǐng)求路徑之后,通過與RequestMapping中的路徑進(jìn)行匹配,找到對(duì)應(yīng)的controller類中的方法,然后通過invoke完成方法調(diào)用,將調(diào)用結(jié)果返回給前端!
2.3、編寫 controller 類
當(dāng)DispatcherServlet編寫完成之后,緊接著我們需要編寫對(duì)應(yīng)的controller控制類來接受前端用戶請(qǐng)求,下面我們以用戶登錄為例,程序示例如下:
編寫一個(gè)LoginController控制類,接受前端用戶調(diào)用
@Controller @RequestMapping("/user") public class LoginController { @Autowired private UserService userService; /** * 用戶登錄 * @param request * @param response * @param userName * @param userPwd * @return */ @RequestMapping("/login") public String login(HttpServletRequest request, HttpServletResponse response, @RequestParam("userName") String userName, @RequestParam("userPwd") String userPwd){ boolean result = userService.login(userName, userPwd); if(result){ return "登錄成功!"; } else { return "登錄失敗!"; } } }
編寫一個(gè)UserService服務(wù)類,用于判斷賬戶、密碼是否正確
public interface UserService { /** * 登錄 * @param userName * @param userPwd * @return */ boolean login(String userName, String userPwd); }
@Service public class UserServiceImpl implements UserService { @Override public boolean login(String userName, String userPwd) { if("zhangsan".equals(userName) && "123456".equals(userPwd)){ return true; } else { return false; } } }
最后,將項(xiàng)目打包成war,通過tomcat啟動(dòng)服務(wù)!
在瀏覽器中訪問http://localhost:8080/user/login?userName=hello&userPwd=123
,結(jié)果顯示如下:
當(dāng)我們將userName和userPwd換成正確的數(shù)據(jù),訪問地址如下:http://localhost:8080/user/login?userName=zhangsan&userPwd=123456
可以很清晰的看到,服務(wù)調(diào)用正常!
三、總結(jié)
本文主要以Spring MVC框架為背景,手寫了一個(gè)簡易版的Spring MVC框架,雖然功能簡陋了一點(diǎn),但是基本無張俱全,里面講解了ioc和自動(dòng)依賴注入的實(shí)現(xiàn)過程,還有前端發(fā)起一個(gè)路徑請(qǐng)求,是如何映射到對(duì)應(yīng)的controller類中的方法上!
當(dāng)然實(shí)際的Spring MVC框架的跳轉(zhuǎn)流程比這個(gè)復(fù)雜很多很多,里面包括各種攔截器、權(quán)限安全管理等等,在后面的文章,小編也會(huì)陸續(xù)進(jìn)行詳細(xì)介紹!
到此這篇關(guān)于\寫一個(gè)SpringMVC框架的文章就介紹到這了,更多相關(guān)寫個(gè)SpringMVC框架內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
簡單了解java標(biāo)識(shí)符的作用和命名規(guī)則
這篇文章主要介紹了簡單了解java標(biāo)識(shí)符的作用和命名規(guī)則,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-01-01JavaSE經(jīng)典小練習(xí)項(xiàng)目之拷貝文件夾
文件拷貝是一個(gè)常見的任務(wù),無論是備份文件,還是將文件從一個(gè)位置復(fù)制到另一個(gè)位置,文件拷貝都是必不可少的,這篇文章主要給大家介紹了關(guān)于JavaSE經(jīng)典小練習(xí)項(xiàng)目之拷貝文件夾的相關(guān)資料,需要的朋友可以參考下2023-10-10詳解Spring Boot 項(xiàng)目部署到heroku爬坑
這篇文章主要介紹了詳解Spring Boot 項(xiàng)目部署到heroku爬坑,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-08-08SpringBoot整合Mybatis實(shí)現(xiàn)CRUD
這篇文章主要介紹了SpringBoot整合Mybatis實(shí)現(xiàn)CRUD的相關(guān)知識(shí),本文給大家介紹的非常詳細(xì),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2019-09-09Java實(shí)現(xiàn)經(jīng)典俄羅斯方塊游戲
俄羅斯方塊是一個(gè)最初由阿列克謝帕吉特諾夫在蘇聯(lián)設(shè)計(jì)和編程的益智類視頻游戲。本文將利用Java實(shí)現(xiàn)這一經(jīng)典的小游戲,需要的可以參考一下2022-01-01