程序博客网 > 狸窝dvd刻录软件 mac

步步为营 SharePoint 开发学习笔记系列 七、SharePoint Timer Job 开发

来源：互联网 发布：狸窝dvd刻录软件 mac 编辑：程序博客网 时间：2024/04/28 15:52

概要

   项目需求要求我们每天晚上同步员工的一些信息到sharepoint 的user List ，我们决定定制开发sharepoint timer Job,Sharepoint timer Job是sharePoint的定时作业Job,需要安装、布曙到服务器上,而这里我只是介绍下Job开发的例子，以供大家学习用。

开发设计

我们需要新建两个类，TaskLoggerJob和TaskLoggerFeature,TaskLoggerJob实现这个Job具体做哪些工和，TaskLoggerFeature实现安装和卸载这个Job以及定义Job执行时间和方式。

在开发Job时需要引用如下Dll

?
1
2
3
using Microsoft.SharePoint;
using Microsoft.SharePoint.Utilities;
using Microsoft.SharePoint.Administration;

TaskLoggerJob设计代码如下:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
public class TaskLoggerJob : SPJobDefinition
{
    #region [Fields]
    #endregion
    #region [Constructors]
    /// <summary>
    /// Initializes a new instance of the TaskLoggerJob class.
    /// </summary>
    publicTaskLoggerJob()
        : base()
    {
    }
    /// <summary>
    /// Initializes a new instance of the TaskLoggerJob class.
    /// </summary>
    /// <param name="jobName">Name of the job.</param>
    /// <param name="service">The service.</param>
    /// <param name="server">The server.</param>
    /// <param name="targetType">Type of the target.</param>
    publicTaskLoggerJob(stringjobName, SPService service, SPServer server, SPJobLockType targetType)
        : base(jobName, service, server, targetType)
    {
    }
    /// <summary>
    /// Initializes a new instance of the TaskLoggerJob class.
    /// </summary>
    /// <param name="jobName">Name of the job.</param>
    /// <param name="webApplication">The web application.</param>
    publicTaskLoggerJob(stringjobName, SPWebApplication webApplication)
        : base(jobName, webApplication,null, SPJobLockType.Job)
    {
        this.Title = "Task Logger";
    }
    #endregion
    #region [Public Methods]
    /// <summary>
    /// Executes the specified content db id.
    /// </summary>
    /// <param name="contentDbId">The content db id.</param>
    publicoverride voidExecute(Guid contentDbId)
    {
        try
        {
            // get a reference to the current site collection's content database
            SPWebApplication webApplication = this.Parentas SPWebApplication;
            SPContentDatabase contentDb = webApplication.ContentDatabases[contentDbId];
            // get a reference to the "Tasks" list in the RootWeb of the first site collection in the content database
            SPList taskList = contentDb.Sites[0].RootWeb.Lists["Tasks"];
            // create a new task, set the Title to the current day/time, and update the item
            SPListItem newTask = taskList.Items.Add();
            newTask["Title"] = DateTime.Now.ToString();
            newTask.Update();
        }
        catch (Exception ex)
        {
            LogHepler.LogToShrepointList(ex);
        }
    }
    #endregion
    #region [Private Methods]
    #endregion
}

在TaskLoggerFeature时我们调用这个构造方法：

?
1
2
3
4
5
6
7
8
9
10
/// <summary>
/// Initializes a new instance of the TaskLoggerJob class.
/// </summary>
/// <param name="jobName">Name of the job.</param>
/// <param name="webApplication">The web application.</param>
public TaskLoggerJob(string jobName, SPWebApplication webApplication)
    :base(jobName, webApplication,null, SPJobLockType.Job)
{
    this.Title ="Task Logger";
}

来初始化SPJobDefinition方法，Job具体要做的事性我们实现这个方法:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/// <summary>
/// Executes the specified content db id.
/// </summary>
/// <param name="contentDbId">The content db id.</param>
public override void Execute(Guid contentDbId)
{
    try
    {
        // get a reference to the current site collection's content database
        SPWebApplication webApplication = this.Parentas SPWebApplication;
        SPContentDatabase contentDb = webApplication.ContentDatabases[contentDbId];
        // get a reference to the "Tasks" list in the RootWeb of the first site collection in the content database
        SPList taskList = contentDb.Sites[0].RootWeb.Lists["Tasks"];
        // create a new task, set the Title to the current day/time, and update the item
        SPListItem newTask = taskList.Items.Add();
        newTask["Title"] = DateTime.Now.ToString();
        newTask.Update();
    }
    catch(Exception ex)
    {
        LogHepler.LogToShrepointList(ex);
    }
}

在这个方法里我们可以同事实现很多任务，而我们这里只是改变了它的title。

下面我们来讲解TaskLoggerFeature的代码设计,首先引用:

?
1
2
using Microsoft.SharePoint;
using Microsoft.SharePoint.Administration;

而后代码如下：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
public class TaskLoggerFeature : SPFeatureReceiver
{
    #region [Override Methods]
    /// <summary>
    /// Active the feature
    /// </summary>
    /// <param name="properties"></param>
    publicoverride voidFeatureActivated(SPFeatureReceiverProperties properties)
    {
        SPSite site = properties.Feature.Parent asSPSite;
        SPSite currentSite = null;
        try
        {
            SPSecurity.RunWithElevatedPrivileges(delegate
            {
               currentSite = newSPSite(site.Url);
            });
            this.InstallTaskLoggerJob(currentSite);
        }
        catch (Exception ex)
        {
            LogHepler.InitConfigListSiteUrl(site.Url);
            LogHepler.LogToShrepointList(ex);
        }
        finally
        {
            if (currentSite !=null)
            {
               currentSite.Dispose();
            }
        }
    }
    /// <summary>
    /// Deactive the feature
    /// </summary>
    /// <param name="properties"></param>
    publicoverride voidFeatureDeactivating(SPFeatureReceiverProperties properties)
    {
        SPSite site = properties.Feature.Parent asSPSite;
        SPSite currentSite = null;
        try
        {
            SPSecurity.RunWithElevatedPrivileges(delegate
            {
               currentSite = newSPSite(site.Url);
            });
            SPWebApplication webApp = currentSite.WebApplication;
            this.UninstallTaskLoggerJob(webApp);
        }
        catch (Exception ex)
        {
            LogHepler.InitConfigListSiteUrl(site.Url);
            LogHepler.LogToShrepointList(ex);
        }
        finally
        {
            if (currentSite !=null)
            {
               currentSite.Dispose();
            }
        }
    }
    /// <summary>
    /// Method that is executed when the feature end the installation
    /// </summary>
    /// <param name="properties"></param>
    publicoverride voidFeatureInstalled(SPFeatureReceiverProperties properties)
    {
    }
    /// <summary>
    /// Method that is executed when the feature is unistalled
    /// </summary>
    /// <param name="properties"></param>
    publicoverride voidFeatureUninstalling(SPFeatureReceiverProperties properties)
    {
    }
    #endregion
    #region [Private Methods]
    /// <summary>
    /// method to install the job
    /// </summary>
    /// <param name="web"></param>
    privatevoid InstallTaskLoggerJob(SPSite site)
    {
        TaskLoggerJob jobDef = newTaskLoggerJob("TaskLoggerJob", site.WebApplication);
        jobDef.Title = "TaskLoggerJob";
        jobDef.Properties.Add("SiteUrl", site.Url);
        this.InstallDayJob(jobDef, site, 23);
        //this.InstallHourJob(jobDef, site, 2);
        //this.InstallMinuteJob(jobDef, site, 10, 10);
    }
    /// <summary>
    /// Method to unistall a job
    /// </summary>
    /// <param name="web">The SPWeb where need to remove the job</param>
    private voidUninstallTaskLoggerJob(SPWebApplication webApp)
    {
        try
        {
           SPJobDefinitionCollection jobColl = webApp.JobDefinitions;
           if (jobColl !=null)
           {
               List<Guid> idsToRemove = newList<Guid>();
               foreach (SPJobDefinition jobDefin jobColl)
               {
                   if (!String.IsNullOrEmpty(jobDef.Title) && jobDef.Title.StartsWith("TaskLoggerJob"))
                   {
                       idsToRemove.Add(jobDef.Id);
                   }
               }
               if (idsToRemove.Count > 0)
               {
                   foreach (Guid gdin idsToRemove)
                   {
                       jobColl.Remove(gd);
                   }
               }
           }
        }
        catch (Exception ex)
        {
           LogHepler.LogToShrepointList(ex);
        }
    }
    /// <summary>
    /// Method to install the job that will execute by hour
    /// </summary>
    /// <param name="jobDef">The JobDefinition to apply</param>
    /// <param name="web">The SPWeb that will execute the job</param>
    /// <param name="minute">The minute to start the job in that hour</param>
    private voidInstallDayJob(SPJobDefinition jobDef, SPSite site, int hour)
    {
        try
        {
           SPWebApplication webApp = site.WebApplication;
           SPJobDefinitionCollection jboColl = webApp.JobDefinitions;
           SPDailySchedule daySched = newSPDailySchedule();
           daySched.BeginHour = hour;
           daySched.BeginMinute = 0;
           daySched.BeginSecond = 0;
           daySched.EndHour = hour;
           daySched.EndMinute = 0;
           daySched.EndSecond = 0;
           jobDef.Schedule = daySched;
           SPJobDefinition oldJob = this.GetJobDeffinition(jobDef.Title, jboColl);
           if (oldJob !=null)
           {
               jboColl.Remove(oldJob.Id);
               webApp.Update();
           }
           jboColl.Add(jobDef);
           webApp.Update();
        }
        catch (Exception ex)
        {
           LogHepler.LogToShrepointList(ex);
        }
    }
    /// <summary>
    /// Method to install the job that will execute by hour
    /// </summary>
    /// <param name="jobDef">The JobDefinition to apply</param>
    /// <param name="web">The SPWeb that will execute the job</param>
    /// <param name="minute">The minute to start the job in that hour</param>
    private voidInstallHourJob(SPJobDefinition jobDef, SPSite site, int minute)
    {
        try
        {
           SPWebApplication webApp = site.WebApplication;
           SPJobDefinitionCollection jboColl = webApp.JobDefinitions;
           SPHourlySchedule hourSched = newSPHourlySchedule();
           hourSched.BeginMinute = minute;
           jobDef.Schedule = hourSched;
           SPJobDefinition oldJob = this.GetJobDeffinition(jobDef.Title, jboColl);
           if (oldJob !=null)
           {
               jboColl.Remove(oldJob.Id);
               webApp.Update();
           }
           jboColl.Add(jobDef);
           webApp.Update();
        }
        catch (Exception ex)
        {
           LogHepler.LogToShrepointList(ex);
        }
    }
    /// <summary>
    /// Method to install the job that will execute by minute
    /// </summary>
    /// <param name="jobDef">The JobDefinition to apply</param>
    /// <param name="web">The SPWeb that will execute the job</param>
    /// <param name="secound">The seconds to start the job in that minute</param>
    private voidInstallMinuteJob(SPJobDefinition jobDef, SPSite site, int second, int interval)
    {
        try
        {
           SPWebApplication webApp = site.WebApplication;
           SPJobDefinitionCollection jboColl = webApp.JobDefinitions;
           
           SPMinuteSchedule minSched = newSPMinuteSchedule();
           minSched.Interval = interval;
           minSched.BeginSecond = second;
           jobDef.Schedule = minSched;
           SPJobDefinition oldJob = this.GetJobDeffinition(jobDef.Title, jboColl);
           if (oldJob !=null)
           {
               jboColl.Remove(oldJob.Id);
               webApp.Update();
           }
           jboColl.Add(jobDef);
           webApp.Update();
        }
        catch (Exception ex)
        {
           LogHepler.LogToShrepointList(ex);
        }
    }
    /// <summary>
    /// Get the JobDefinition to install or remove
    /// </summary>
    /// <param name="Title">Title of the job</param>
    /// <param name="jobCollection">The JobCollection to find the job</param>
    /// <returns>JbDefinition that found in this collection</returns>
    private SPJobDefinition GetJobDeffinition(stringTitle, SPJobDefinitionCollection jobCollection)
    {
        SPJobDefinition result = null;
        if (jobCollection !=null)
        {
           foreach (SPJobDefinition jobin jobCollection)
           {
               if (job.Title.Equals(Title))
               {
                   result = job;
                   break;
               }
           }
        }
        return result;
    }
    #endregion
}

下面这个方法是激活这个Job的feature,在sharepoint里每一个Job都有一个feature来讲行实现，它会生成相应的feature的xml方件:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/// <summary>
/// Active the feature
/// </summary>
/// <param name="properties"></param>
public override void FeatureActivated(SPFeatureReceiverProperties properties)
{
    SPSite site = properties.Feature.Parentas SPSite;
    SPSite currentSite =null;
    try
    {
        SPSecurity.RunWithElevatedPrivileges(delegate
        {
            currentSite = newSPSite(site.Url);
        });
        this.InstallTaskLoggerJob(currentSite);
    }
    catch(Exception ex)
    {
        LogHepler.InitConfigListSiteUrl(site.Url);
        LogHepler.LogToShrepointList(ex);
    }
    finally
    {
        if (currentSite !=null)
        {
            currentSite.Dispose();
        }
    }
}
?
1
?
1
?
1
卸载这个Job的方法如下：
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
/// <summary>
/// Deactive the feature
/// </summary>
/// <param name="properties"></param>
public override void FeatureDeactivating(SPFeatureReceiverProperties properties)
{
    SPSite site = properties.Feature.Parentas SPSite;
    SPSite currentSite =null;
    try
    {
        SPSecurity.RunWithElevatedPrivileges(delegate
        {
            currentSite = newSPSite(site.Url);
        });
        SPWebApplication webApp = currentSite.WebApplication;
        this.UninstallTaskLoggerJob(webApp);
    }
    catch(Exception ex)
    {
        LogHepler.InitConfigListSiteUrl(site.Url);
        LogHepler.LogToShrepointList(ex);
    }
    finally
    {
        if (currentSite !=null)
        {
            currentSite.Dispose();
        }
    }
}

Job的执行时间可以按分、时、天、月、年来执行可以进行如下定义，分、时、天。概据你的需要来执行。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/// <summary>
/// Method to install the job that will execute by hour
/// </summary>
/// <param name="jobDef">The JobDefinition to apply</param>
/// <param name="web">The SPWeb that will execute the job</param>
/// <param name="minute">The minute to start the job in that hour</param>
privatevoid InstallDayJob(SPJobDefinition jobDef, SPSite site,int hour)
{
    try
    {
        SPWebApplication webApp = site.WebApplication;
        SPJobDefinitionCollection jboColl = webApp.JobDefinitions;
        SPDailySchedule daySched = newSPDailySchedule();
        daySched.BeginHour = hour;
        daySched.BeginMinute = 0;
        daySched.BeginSecond = 0;
        daySched.EndHour = hour;
        daySched.EndMinute = 0;
        daySched.EndSecond = 0;
        jobDef.Schedule = daySched;
        SPJobDefinition oldJob = this.GetJobDeffinition(jobDef.Title, jboColl);
        if (oldJob != null)
        {
            jboColl.Remove(oldJob.Id);
            webApp.Update();
        }
        jboColl.Add(jobDef);
        webApp.Update();
    }
    catch(Exception ex)
    {
        LogHepler.LogToShrepointList(ex);
    }
}
/// <summary>
/// Method to install the job that will execute by hour
/// </summary>
/// <param name="jobDef">The JobDefinition to apply</param>
/// <param name="web">The SPWeb that will execute the job</param>
/// <param name="minute">The minute to start the job in that hour</param>
privatevoid InstallHourJob(SPJobDefinition jobDef, SPSite site,int minute)
{
    try
    {
        SPWebApplication webApp = site.WebApplication;
        SPJobDefinitionCollection jboColl = webApp.JobDefinitions;
        SPHourlySchedule hourSched = newSPHourlySchedule();
        hourSched.BeginMinute = minute;
        jobDef.Schedule = hourSched;
        SPJobDefinition oldJob = this.GetJobDeffinition(jobDef.Title, jboColl);
        if (oldJob != null)
        {
            jboColl.Remove(oldJob.Id);
            webApp.Update();
        }
        jboColl.Add(jobDef);
        webApp.Update();
    }
    catch(Exception ex)
    {
        LogHepler.LogToShrepointList(ex);
    }
}
/// <summary>
/// Method to install the job that will execute by minute
/// </summary>
/// <param name="jobDef">The JobDefinition to apply</param>
/// <param name="web">The SPWeb that will execute the job</param>
/// <param name="secound">The seconds to start the job in that minute</param>
privatevoid InstallMinuteJob(SPJobDefinition jobDef, SPSite site,int second,int interval)
{
    try
    {
        SPWebApplication webApp = site.WebApplication;
        SPJobDefinitionCollection jboColl = webApp.JobDefinitions;
       
        SPMinuteSchedule minSched = newSPMinuteSchedule();
        minSched.Interval = interval;
        minSched.BeginSecond = second;
        jobDef.Schedule = minSched;
        SPJobDefinition oldJob = this.GetJobDeffinition(jobDef.Title, jboColl);
        if (oldJob != null)
        {
            jboColl.Remove(oldJob.Id);
            webApp.Update();
        }
        jboColl.Add(jobDef);
        webApp.Update();
    }
    catch (Exception ex)
    {
        LogHepler.LogToShrepointList(ex);
    }
}

在完成了上面的代码设计后，我们接着就需要把Job布曙到服务器中。

要以上代码生成Windows SharePoint Solution Package (*.WSP) 来布曙。

步骤如下：

一、首先进入sharePoint Central administrator v3 管理页面，选择Operation下的Solution Management

image

二、检索TaskLoggerJob.wsp

如果以前安装过这个Job先要卸载，再安装。 
三、执行命令   stsadm -o addsolution -filename "TaskLoggerJob.wsp"  添加Job的solution

四、执行命令 stsadm -o deactivatefeature -name TaskLoggerJob -url http://[site]/
      而后再执行命令  stsadm -o execadmsvcjobs 
五、执行命令 stsadm -o activatefeature -name TaskLoggerJob -url http://[site]/
      而后再执行命令  stsadm -o execadmsvcjobs

总结

sharepoint timer job是用来完成系统定里执行的一此任务，是由这个进程完成的OWSTIMER.EXE

狸窝dvd刻录软件 mac 狸窝dvd刻录软件 mac
原创粉丝点击
热门IT博客
gear vr 优化gear vr 优化
linux 删除文件夹函数linux 删除文件夹函数
web服务器软件排名
欧弟现状知乎
windows winsxs文件夹
如何避免淘宝订单清洗
思科网络培训
淘宝售后换货流程
json数据里的函数
2017人工智能产业年会
php 权限管理 数据
oracle sql top用法
danner军靴 知乎
剑三脸型数据
知到 西方文明史导论
java pagecache
淘宝助理教程视频
淘宝参数是什么意思
造字软件手机版
深入理解java 虚拟机
热门问题 老师的惩罚 人脸识别 我在镇武司摸鱼那些年 重生之率土为王 我在大康的咸鱼生活 盘龙之生命进化 天生仙种 凡人之先天五行 春回大明朝 姑娘不必设防，我是瞎子 校运会加油稿200字 运动会赞稿50字 运动会加油稿30字左右 跳远加油稿100字 运动会通讯稿100字 运动会加油稿20字左右 运动加油稿100字 运动会加油稿400字左右 校运会加油稿100字20篇 100米加油稿50字 通讯稿范文大全300字 加油稿150字 运动会加油稿20字大全 加油稿150字左右 运动会加油稿80字 运动会加油稿50字左右 运动会通讯稿150字 运动会报道稿200字 运动会加油稿50字精选 加油稿20字大全 致运动员加油稿50字 校运动会加油稿200字 运动会古风押韵加油稿100字 运动会古风押韵加油稿40字 秋季运动会加油稿50字 罗马字符 特殊字符 字符 字符是什么 字符集 万字符 转义字符 拉丁字符 字符编码 字符间距 字符常量 空白字符 字符缩放 字符型 字符表情 字符底纹

程序博客网，程序员的互联网技术博客家园。csdn论坛精品 msdn技术资料都在这里