Skip to content

Latest commit

 

History

History
128 lines (112 loc) · 6.2 KB

README.md

File metadata and controls

128 lines (112 loc) · 6.2 KB
Raw

特别说明：

本文档自2020年9月份开始就没有更新了，作者最近比较忙，所以如果志同道合的你对撰写zqMVC的使用文档感兴趣，并且熟悉如何使用Markdown，愿意一起为zqMVC贡献自己的一份力，可以通过邮箱联系我。期待你的加入！！！

zqMVC是什么？

zqMVC是一个简易的Java MVC框架，当然，它简易的到了你可以把它看作是一个工具类。



zqMVC可以干什么？

zqMVC可以摆脱开发传统JavaWeb应用编写大量Servlet的束缚。在传统JavaWeb应 用开发中，一个Servlet只能处理一个URL的对应的请求，zqMVC不一样，它可以使用一个“Router”处理许多个不同的URL请求，而且这些处理的过程和逻辑，完全有开发者自己定义。



如何使用zqMVC？

1、首先在你的项目你需要导入zqMVC的jar包，此外你还需要在你的项目中引入fastjson
的jar包。
2、在web.xml中配置请求分发器DispacherServlet及其映射，拦截所有请求

<servlet>
    <servlet-name>zqMvc</servlet-name>
    <servlet-class>zqmvc.servlets.DispacherServlet</servlet-class>
    <init-param>
      <param-name>configuration</param-name>
      <param-value>zqMVC.properties</param-value>
    </init-param>
  </servlet>
  <servlet-mapping>
    <servlet-name>zqMvc</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>

其中DispacherServlet的初始化参数configuration的值为一个properties的配置文件，该文件处于项目的resources目录下。
你需要在配置文件中配置一个，以便zqMVC快速的扫描到你编写的的Router：RouterPackagetName=xxxx，该属性的值为router所在的包的包名

3、处理静态资源
zqMVC目前处理的静态资源是交由Tomcat内置的defaultServlet处理静态资源，目前支持处理以css、js、jpg、JPG、png、PNG、mp4为扩展名的资源文件。后续zqMVC将支持自定义静态资源类型和资源文件路径，敬请期待！

如果zqMVC暂时还不能满足你的静态资源的类型，你可以自行在web.xml中配置资源类型并交由defaultServlet去处理

//完整配置如下：
<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
  <display-name>zqMVC</display-name>

  <servlet>
    <servlet-name>zqMvc</servlet-name>
    <servlet-class>zqmvc.servlets.DispacherServlet</servlet-class>
    <init-param>
      <param-name>packageName</param-name>
      <param-value>zq.controller</param-value>
    </init-param>
  </servlet>

<!--  zqMVC暂时无法处理的静态资源类型，使用Tomcat默认的defaultServlet处理-->
  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.你的资源扩展名</url-pattern>
  </servlet-mapping>

  <servlet-mapping>
    <servlet-name>zqMvc</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>

</web-app>

4、定义Router

//示例：
@Router
@URLMapping(value = "/test")
public class TestController {

    @URLMapping("one")
    public String test(){
        return "index.jsp";
    }

    @URLMapping("two")
    public User test2(HttpServletRequest request, HttpServletResponse response){
        System.out.println(request.getParameter("zqMVC"));
        return new User("zqMVC",21);
    }
}

被@Router注解的类将被zqMVC扫描到，zqMVC扫描到该类后便会处理该类的配置的所有映射，当访问对应的URL时便会调用相应的方法进行处理。
例如：当访问 http://localhost:8080/zqMVC/test/one 这个URL时，zqMVC便会执行TestController类中的test方法，你可以在该方法中处理你的业务请求。
特别说明：@URLMapping注解使用在类上时，必须使用value接收一个String类型的值，且该String必须以“/”开头。@URLMapping注解使用在方法上时，可以不用value赋值一个String类型的值，直接接收一个String类型的参数，且该String参数不能以“/”开头或者结尾

5、处理请求的参数
从上述的Router定义中可以看到方法test2方法中有两个参数：request和response,这两个参数的类型分别为HttpServletRequest和HttpServletResponse，通过这两个参数，你可以对请求和相应进行相应的配置、获取请求参数、返回数据。

6、响应视图和其他类型数据
zqMVC目前仅支持JSP视图，当Router中的方法返回类型是String类型时，zqMVC会把该值当作一个视图路径，该路径不能以“/”开头，且不能时是相对路径，zqMVC会自动给 返回的String加上“/”，该绝对路径的根目录是webapp目录（你的web项目的部署目录）。当Router中的方法返回类型不是String类型时，zqMVC会把返回值进行JSON字符串化并响应该字符串。



更新日志

2020-09-02

1、解耦部分逻辑，可以使用配置文件来配置zqMVC啦！让你可以更加个性化的配置zqMVC，请查看使用文档的介绍。
2、静态资源的处理不再是使用web.xml文件的相关配置进行处理，而是改为了由zqMVC来处理，目前支持处理以css、js、jpg、JPG、png、PNG、mp4为扩展名的资源文件。

2020-08-12

支持URL的重定向

当Router方法的返回值是String且以“redirect:”开头时，zqMVC会将后面的字符串作为重定向到的URL，“redirect:”后面的字符串以“/”开头时，表示绝对路径，使用相对路径时不能以形如“./”或者“../”开头，只能是以非“/”开头的字符串。

	//示例
	@Router
	@URLMapping(value = "/test")
	public class TestController {

		@URLMapping("one")
		public String test(){
			return "index.jsp";
		}

		@URLMapping("two")
		public User test2(HttpServletRequest request, HttpServletResponse response){
			System.out.println(request.getParameter("zqMVC"));
			return new User("zqMVC",21);
		}

		@URLMapping("three")
		public String test3(){
			return "redirect:/test/two";
			//return "redirect:two";
		}
	}

当访问URL http://localhost:8080/zqMVC/test/three 后，以上两个return都将重定向到 http://localhost:8080/zqMVC/test/two 。