Apache Sling Servlet Archetype 使用教程

1. 项目的目录结构及介绍

Apache Sling Servlet Archetype 生成的项目结构如下：

sling-servlet-archetype/
├── pom.xml
├── README.md
└── src
    ├── main
    │   ├── java
    │   │   └── com
    │   │       └── example
    │   │           └── sling
    │   │               └── servlets
    │   │                   └── SampleServlet.java
    │   └── resources
    │       └── META-INF
    │           └── services
    │               └── org.apache.sling.api.servlets.ServletResolver
    └── test
        └── java
            └── com
                └── example
                    └── sling
                        └── servlets
                            └── SampleServletTest.java

目录结构介绍

• pom.xml: Maven 项目配置文件。
• README.md: 项目说明文档。
• src/main/java: 存放 Java 源代码。
  • com/example/sling/servlets/SampleServlet.java: 示例 Servlet 类。
• src/main/resources: 存放资源文件。
  • META-INF/services/org.apache.sling.api.servlets.ServletResolver: 服务注册文件。
• src/test/java: 存放测试代码。
  • com/example/sling/servlets/SampleServletTest.java: 示例 Servlet 测试类。

2. 项目的启动文件介绍

项目的启动文件主要是 SampleServlet.java，位于 src/main/java/com/example/sling/servlets/ 目录下。

SampleServlet.java

package com.example.sling.servlets;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingAllMethodsServlet;
import org.osgi.service.component.annotations.Component;

import javax.servlet.Servlet;
import javax.servlet.ServletException;
import java.io.IOException;

@Component(
    service = Servlet.class,
    property = {
        "sling.servlet.paths=/bin/sample",
        "sling.servlet.methods=GET"
    }
)
public class SampleServlet extends SlingAllMethodsServlet {
    @Override
    protected void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) throws ServletException, IOException {
        response.getWriter().write("Hello, Sling!");
    }
}

启动文件介绍

• @Component: 使用 OSGi DS 1.4 注解，注册 Servlet 服务。
• sling.servlet.paths: 定义 Servlet 的路径。
• sling.servlet.methods: 定义支持的请求方法。
• doGet 方法：处理 GET 请求，返回 "Hello, Sling!"。

3. 项目的配置文件介绍

项目的配置文件主要是 pom.xml，位于项目根目录下。

pom.xml

<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>
    <groupId>com.example</groupId>
    <artifactId>sling-servlet-archetype</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>bundle</packaging>

    <dependencies>
        <!-- Sling dependencies -->
        <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.api</artifactId>
            <version>2.15.2</version>
        </dependency>
        <!-- Other dependencies -->
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>