用grails来实现网站API的一个思路

众所周知，目前很多网站都提供了API的服务，其中也包括JavaEye。调用网站的API可以提供接口给其他系统使用，方便开发者实现mashup。

一般的API可以是web service,也可以是返回xml、json，其实web service也是返回xml。我们使用grails可以非常容易实现返回xml，而无需借助任何插件。当然在grails中使用web service也相当容易。

下面是一个API的controller：

import grails.converters.*

class ApiController {
    def login = {
        def userName = params.userName
        def password = params.password
        def user = User.findWhere(userName:userName,password:password)
        if (user)
           render user as XML
        else
           render(text:"<xml><user>not found user</user></xml>",contentType:"text/xml",encoding:"UTF-8")
    }

}

这样访问http://localhost:8080/工程名称/api/login?userName=test&password=test

如果存在用户名为test 密码为test的用户，则返回类似如下的xml：

  <?xml version="1.0" encoding="UTF-8" ?> 
  <user id="2">
  <userName>test</userName> 
  <password>test</password> 
  </user>

如果不存在该用户 也会返回一段xml。

如果需要添加其他的方法供外界调用，只需增加一个action，将其render as xml

需要注意的一点是：如果使用了grails的filter，必须修改相应的filter，比如我的代码如下：

class LoginFilters {
    def filters = {
        loginCheck(controller:'*', action:'*'){
            before = {
                if (params.controller == "api") {
                    return true
                }
                if(!session.user) {
                    if( !actionName.equals('login') && !actionName.equals('doLogin') ) {
                        redirect(controller:'user',action:'login')
                        return false
                    }
                }
            }
        }
    }
}

这样，如果访问apicontroller，就可以返回xml，否则的话只能返回登陆页面

其他的client端或者别的，只需解析xml就能得到相应的数据。

比如：使用andorid做一个系统的客户端，该系统采用grails实现，首先第一步就需要登陆系统。登陆的话就要验证用户名和密码。

登陆的代码如下：

import org.apache.http.client.HttpClient;
import org.apache.http.client.ResponseHandler;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.BasicResponseHandler;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.params.HttpProtocolParams;
import org.dom4j.Document;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;

import android.app.Activity;
import android.app.Dialog;
import android.content.Context;
import android.content.Intent;
import android.os.Bundle;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.Button;
import android.widget.EditText;

/**
 * @author Tony Shen
 *
 */
public class LoginActivity extends Activity {

	Button cancleButton; //取消按钮
	Button loginButton;  //登陆按钮
	String responseBody = null;
	String result = null;
    /** Called when the activity is first created. */
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.login);
        validate();
    }

    private void validate() {
    	cancleButton = (Button) findViewById(R.id.cancel);
    	cancleButton.setOnClickListener(cancleListener);

    	loginButton = (Button) findViewById(R.id.login);
		loginButton.setOnClickListener(loginListener);
    }

    // cancle按钮监听器
    OnClickListener cancleListener = new OnClickListener() {
		public void onClick(View v) {
			Intent intent0 = new Intent(LoginActivity.this, LoginActivity.class);
			startActivity(intent0);
		}
	};

	// login按钮监听器
	OnClickListener loginListener = new OnClickListener() {
		public void onClick(View v) {
			CharSequence userNameValue = ((EditText) findViewById(R.id.username)).getText();
			CharSequence passwordValue = ((EditText) findViewById(R.id.password)).getText();

	        String url = "/TheSales/api/login";   
	        String host = "192.168.1.2:8080";
	        String params = "userName="+userNameValue.toString()+"&password="+passwordValue.toString();
	        HttpClient httpclient = new DefaultHttpClient();
	        httpclient.getParams().setParameter(HttpProtocolParams.HTTP_CONTENT_CHARSET,"UTF-8");

	        HttpGet httpget = new HttpGet("http://"+host+url+"?"+params);
	        ResponseHandler<String> responseHandler = new BasicResponseHandler();
	        try {
	        	responseBody = httpclient.execute(httpget, responseHandler);
		        Document document = DocumentHelper.parseText(responseBody);
		        Element root = document.getRootElement();
		        if("not found user".equals(root.elementText("user")))
		        {
		        	showDialog(1);
		        } else {
					Intent intent1 = new Intent(LoginActivity.this,c.class);
					startActivity(intent1);
				}
			} catch (Exception e) {
				e.printStackTrace();
			}
		}
	};

	protected Dialog onCreateDialog(int id) {
		return buildDialog(LoginActivity.this);
	}

	private Dialog buildDialog(Context context) {
		Dialog dialog = new Dialog(context);
		dialog.setTitle("用户名或密码出错，请重新输入！");
		return  dialog;
	}
}

LoginActivity主要是通过HttpClient模拟请求系统，调用网站的api，返回xml。然后解析xml验证是否存在该用户。

MainActivity的代码很简单，主要使用main.xml,如下：

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
	android:orientation="vertical" android:layout_width="fill_parent"
	android:layout_height="fill_parent">
	<TextView android:id="@+id/android:empty"
		android:layout_width="wrap_content"
		android:layout_height="wrap_content" android:text="登陆成功!" />
</LinearLayout>

这样我们就可以登陆系统了，界面很简单，只不过是通过这个思路实现网站的API
[img]http://dl.iteye.com/upload/attachment/206548/84cb8a2d-11e1-3bce-84e8-376ce4b2c536.jpg[/img]